Create Workflow

Create Workflow

curl --request POST \
  --url https://api.truthlocks.com/v1/orchestrate/workflows \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Data Quality Pipeline",
  "steps": [
    {
      "action": "validate_schema",
      "agent_id": "550e8400-e29b-41d4-a716-446655440000",
      "parameters": {
        "strict": true
      }
    },
    {
      "action": "check_anomalies",
      "agent_id": "550e8400-e29b-41d4-a716-446655440001"
    }
  ],
  "triggers": {
    "cron": "0 */6 * * *"
  }
}
'

import requests

url = "https://api.truthlocks.com/v1/orchestrate/workflows"

payload = {
    "name": "Data Quality Pipeline",
    "steps": [
        {
            "action": "validate_schema",
            "agent_id": "550e8400-e29b-41d4-a716-446655440000",
            "parameters": { "strict": True }
        },
        {
            "action": "check_anomalies",
            "agent_id": "550e8400-e29b-41d4-a716-446655440001"
        }
    ],
    "triggers": { "cron": "0 */6 * * *" }
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Data Quality Pipeline',
    steps: [
      {
        action: 'validate_schema',
        agent_id: '550e8400-e29b-41d4-a716-446655440000',
        parameters: {strict: true}
      },
      {action: 'check_anomalies', agent_id: '550e8400-e29b-41d4-a716-446655440001'}
    ],
    triggers: {cron: '0 */6 * * *'}
  })
};

fetch('https://api.truthlocks.com/v1/orchestrate/workflows', 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.truthlocks.com/v1/orchestrate/workflows",
  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([
    'name' => 'Data Quality Pipeline',
    'steps' => [
        [
                'action' => 'validate_schema',
                'agent_id' => '550e8400-e29b-41d4-a716-446655440000',
                'parameters' => [
                                'strict' => true
                ]
        ],
        [
                'action' => 'check_anomalies',
                'agent_id' => '550e8400-e29b-41d4-a716-446655440001'
        ]
    ],
    'triggers' => [
        'cron' => '0 */6 * * *'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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.truthlocks.com/v1/orchestrate/workflows"

	payload := strings.NewReader("{\n  \"name\": \"Data Quality Pipeline\",\n  \"steps\": [\n    {\n      \"action\": \"validate_schema\",\n      \"agent_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"parameters\": {\n        \"strict\": true\n      }\n    },\n    {\n      \"action\": \"check_anomalies\",\n      \"agent_id\": \"550e8400-e29b-41d4-a716-446655440001\"\n    }\n  ],\n  \"triggers\": {\n    \"cron\": \"0 */6 * * *\"\n  }\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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.truthlocks.com/v1/orchestrate/workflows")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Data Quality Pipeline\",\n  \"steps\": [\n    {\n      \"action\": \"validate_schema\",\n      \"agent_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"parameters\": {\n        \"strict\": true\n      }\n    },\n    {\n      \"action\": \"check_anomalies\",\n      \"agent_id\": \"550e8400-e29b-41d4-a716-446655440001\"\n    }\n  ],\n  \"triggers\": {\n    \"cron\": \"0 */6 * * *\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.truthlocks.com/v1/orchestrate/workflows")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Data Quality Pipeline\",\n  \"steps\": [\n    {\n      \"action\": \"validate_schema\",\n      \"agent_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"parameters\": {\n        \"strict\": true\n      }\n    },\n    {\n      \"action\": \"check_anomalies\",\n      \"agent_id\": \"550e8400-e29b-41d4-a716-446655440001\"\n    }\n  ],\n  \"triggers\": {\n    \"cron\": \"0 */6 * * *\"\n  }\n}"

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

{
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "steps": [
    {
      "action": "<string>",
      "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parameters": {}
    }
  ],
  "triggers": {},
  "created_at": "2023-11-07T05:31:56Z"
}

{
  "code": "AUTH_REQUIRED",
  "message": "Authentication required",
  "http_status": 401
}

{
  "code": "AUTH_REQUIRED",
  "message": "Authentication required",
  "http_status": 401
}

{
  "code": "AUTH_REQUIRED",
  "message": "Authentication required",
  "http_status": 401
}

POST

orchestrate

workflows

Create Workflow

curl --request POST \
  --url https://api.truthlocks.com/v1/orchestrate/workflows \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Data Quality Pipeline",
  "steps": [
    {
      "action": "validate_schema",
      "agent_id": "550e8400-e29b-41d4-a716-446655440000",
      "parameters": {
        "strict": true
      }
    },
    {
      "action": "check_anomalies",
      "agent_id": "550e8400-e29b-41d4-a716-446655440001"
    }
  ],
  "triggers": {
    "cron": "0 */6 * * *"
  }
}
'

import requests

url = "https://api.truthlocks.com/v1/orchestrate/workflows"

payload = {
    "name": "Data Quality Pipeline",
    "steps": [
        {
            "action": "validate_schema",
            "agent_id": "550e8400-e29b-41d4-a716-446655440000",
            "parameters": { "strict": True }
        },
        {
            "action": "check_anomalies",
            "agent_id": "550e8400-e29b-41d4-a716-446655440001"
        }
    ],
    "triggers": { "cron": "0 */6 * * *" }
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Data Quality Pipeline',
    steps: [
      {
        action: 'validate_schema',
        agent_id: '550e8400-e29b-41d4-a716-446655440000',
        parameters: {strict: true}
      },
      {action: 'check_anomalies', agent_id: '550e8400-e29b-41d4-a716-446655440001'}
    ],
    triggers: {cron: '0 */6 * * *'}
  })
};

fetch('https://api.truthlocks.com/v1/orchestrate/workflows', 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.truthlocks.com/v1/orchestrate/workflows",
  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([
    'name' => 'Data Quality Pipeline',
    'steps' => [
        [
                'action' => 'validate_schema',
                'agent_id' => '550e8400-e29b-41d4-a716-446655440000',
                'parameters' => [
                                'strict' => true
                ]
        ],
        [
                'action' => 'check_anomalies',
                'agent_id' => '550e8400-e29b-41d4-a716-446655440001'
        ]
    ],
    'triggers' => [
        'cron' => '0 */6 * * *'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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.truthlocks.com/v1/orchestrate/workflows"

	payload := strings.NewReader("{\n  \"name\": \"Data Quality Pipeline\",\n  \"steps\": [\n    {\n      \"action\": \"validate_schema\",\n      \"agent_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"parameters\": {\n        \"strict\": true\n      }\n    },\n    {\n      \"action\": \"check_anomalies\",\n      \"agent_id\": \"550e8400-e29b-41d4-a716-446655440001\"\n    }\n  ],\n  \"triggers\": {\n    \"cron\": \"0 */6 * * *\"\n  }\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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.truthlocks.com/v1/orchestrate/workflows")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Data Quality Pipeline\",\n  \"steps\": [\n    {\n      \"action\": \"validate_schema\",\n      \"agent_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"parameters\": {\n        \"strict\": true\n      }\n    },\n    {\n      \"action\": \"check_anomalies\",\n      \"agent_id\": \"550e8400-e29b-41d4-a716-446655440001\"\n    }\n  ],\n  \"triggers\": {\n    \"cron\": \"0 */6 * * *\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.truthlocks.com/v1/orchestrate/workflows")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Data Quality Pipeline\",\n  \"steps\": [\n    {\n      \"action\": \"validate_schema\",\n      \"agent_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"parameters\": {\n        \"strict\": true\n      }\n    },\n    {\n      \"action\": \"check_anomalies\",\n      \"agent_id\": \"550e8400-e29b-41d4-a716-446655440001\"\n    }\n  ],\n  \"triggers\": {\n    \"cron\": \"0 */6 * * *\"\n  }\n}"

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

{
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "steps": [
    {
      "action": "<string>",
      "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parameters": {}
    }
  ],
  "triggers": {},
  "created_at": "2023-11-07T05:31:56Z"
}

{
  "code": "AUTH_REQUIRED",
  "message": "Authentication required",
  "http_status": 401
}

{
  "code": "AUTH_REQUIRED",
  "message": "Authentication required",
  "http_status": 401
}

{
  "code": "AUTH_REQUIRED",
  "message": "Authentication required",
  "http_status": 401
}

Creates a new workflow definition. Workflows define a directed acyclic graph (DAG) of steps that orchestrations execute in sequence. Each step specifies its type, configuration, and dependencies — enabling complex multi-step AI pipelines with deterministic execution order. Workflows are created in draft status and must be published before they can be executed. This two-phase approach allows teams to review and validate workflow definitions before they are available to agents.

Authentication

string

required

API key with workflows:write scope. Alternatively, pass a Bearer JWT token in the Authorization header.

string

required

Tenant identifier for multi-tenant isolation.

Request

string

required

Human-readable workflow name. Must be unique within the tenant namespace per version.

string

Description of what this workflow accomplishes.

object[]

required

Array of workflow step definitions. Each step contains: - name (string, required) — Unique step identifier within the workflow - type (string, required) — Step type: llm_inference, tool_call, guardrail_check, decision, transform, webhook - config (object, required) — Step-specific configuration (model, tool name, guardrail rules, etc.) - depends_on (string[]) — Array of step names that must complete before this step executes

string

Semantic version of the workflow (e.g. 1.0.0). Defaults to 1.0.0 if omitted.

Response

string

Unique workflow identifier.

string

Workflow name.

string

Workflow description.

string

Workflow version.

array

The validated workflow step definitions.

string

Workflow status. Always draft on creation.

string

ISO 8601 timestamp of creation.

Authorizations

X-API-Key

string

header

required

API key for machine-to-machine authentication

Body

application/json

name

string

required

Workflow name

steps

object[]

required

Ordered workflow steps

Show child attributes

triggers

object

Trigger conditions (cron, event, webhook)

Response

Workflow created

workflow_id

string<uuid>

name

string

steps

object[]

Show child attributes

triggers

object

created_at

string<date-time>

Attestations

Receipts

Risk Evaluation

Risk Signals

Account Takeover

Velocity Scoring

Verification

Verification Packs

Issuers

API Keys

Policies

Issuer Applications

Identity & Access

Webhooks

Audit & Logs

Consumer (B2C)

Billing

Machine Agents

Agent Sessions & Tools

Trust & Witness

Truth Claims & Documents

Compliance & Anomalies

Datasets & Models

Orchestrations & Workflows

Guardrails & Delegation

MAIP Policies

Observability

Assets

Governance

Announcements

Blog Management

Leads

System

Authentication

Request

Response

Authorizations

Body

Response

​Authentication

​Request

​Response

Authorizations

Body

Response

Authentication

Request

Response