> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Create Workflow
> Create a workflow definition as a directed acyclic graph (DAG) of steps for repeatable AI orchestrations.
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
API key with `workflows:write` scope. Alternatively, pass a Bearer JWT token
in the `Authorization` header.
Tenant identifier for multi-tenant isolation.
### Request
Human-readable workflow name. Must be unique within the tenant namespace per
version.
Description of what this workflow accomplishes.
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
Semantic version of the workflow (e.g. `1.0.0`). Defaults to `1.0.0` if
omitted.
### Response
Unique workflow identifier.
Workflow name.
Workflow description.
Workflow version.
The validated workflow step definitions.
Workflow status. Always `draft` on creation.
ISO 8601 timestamp of creation.
## OpenAPI
````yaml mint-openapi.yaml POST /v1/orchestrate/workflows
openapi: 3.0.3
info:
title: Truthlocks API
description: >
Truthlocks is a universal verification infrastructure for documents,
credentials, and digital assets.
This specification defines the canonical API for interacting with Truthlocks
services.
## Base URLs
- **Production**: `https://api.truthlocks.com`
- **Sandbox**: `https://sandbox-api.truthlocks.com`
## Authentication
- **API Keys**: Use `X-API-Key` header for machine-to-machine operations
- **Bearer Tokens**: Use `Authorization: Bearer ` for user-initiated
operations
## Tenant Identity
In production, tenant identity is derived from the authenticated context
(API key or JWT).
The `X-Tenant-ID` header is ignored in production to prevent spoofing.
version: 1.0.0
contact:
name: Truthlocks Support
url: https://truthlocks.com/support
email: support@truthlocks.com
servers:
- url: https://api.truthlocks.com
description: Production API
- url: https://sandbox-api.truthlocks.com
description: Sandbox Environment
security:
- APIKey: []
tags:
- name: Authentication
description: API key and token management
- name: Issuers
description: Issuer registration and trust management
- name: Keys
description: Cryptographic key management for issuers
- name: Attestations
description: Attestation lifecycle (mint, revoke, supersede)
- name: Verification
description: Attestation verification and proof bundles
- name: Governance
description: Issuer governance workflows (admin only)
- name: Identity
description: Organization, user, and role management
- name: Audit
description: Audit event queries
- name: Platform
description: Platform administration (super admin only)
- name: Platform Review
description: Staff review workflows for issuer applications
- name: Tenant Console
description: Tenant profile and lifecycle endpoints
- name: Health
description: Service health and readiness endpoints
- name: Risk
description: Risk signal ingestion and fraud detection
- name: Risk Enforcement
description: Risk enforcement actions — block, challenge, quarantine, and configuration
- name: Billing
description: Billing, subscription, and addon management
- name: Machine Identity
description: >-
Machine Agent Identity Protocol (MAIP) — agent registration, sessions,
trust, witness, compliance, orchestration, and observability
externalDocs:
description: Transparency read-only API (separate service spec)
url: >-
https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
/v1/orchestrate/workflows:
post:
tags:
- Machine Identity
summary: Create Workflow
description: |
Defines a reusable workflow composed of ordered steps, each assigned to
an agent with specific parameters. Workflows can be triggered manually
or via configured triggers.
operationId: maip.workflows.create
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
- steps
properties:
name:
type: string
description: Workflow name
steps:
type: array
items:
type: object
required:
- action
- agent_id
properties:
action:
type: string
description: Action to perform
agent_id:
type: string
format: uuid
description: Agent assigned to this step
parameters:
type: object
additionalProperties: true
description: Ordered workflow steps
triggers:
type: object
additionalProperties: true
description: Trigger conditions (cron, event, webhook)
example:
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 * * *
responses:
'201':
description: Workflow created
content:
application/json:
schema:
$ref: '#/components/schemas/MaipWorkflow'
'400':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
'401':
description: Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
'429':
description: Rate limit exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
security:
- APIKey: []
components:
schemas:
MaipWorkflow:
type: object
properties:
workflow_id:
type: string
format: uuid
name:
type: string
steps:
type: array
items:
type: object
properties:
action:
type: string
agent_id:
type: string
format: uuid
parameters:
type: object
additionalProperties: true
triggers:
type: object
additionalProperties: true
created_at:
type: string
format: date-time
ErrorEnvelope:
type: object
required:
- code
- message
- http_status
properties:
code:
type: string
description: Machine-readable error code
enum:
- AUTH_REQUIRED
- AUTH_INVALID
- PERMISSION_DENIED
- TENANT_IDENTITY_UNVERIFIED
- NOT_FOUND
- VALIDATION_ERROR
- CONFLICT
- PAYLOAD_TOO_LARGE
- RATE_LIMIT_EXCEEDED
- QUOTA_EXCEEDED
- SERVICE_UNAVAILABLE
- INTERNAL_ERROR
message:
type: string
description: Human-readable error message
http_status:
type: integer
description: HTTP status code
retry_after_ms:
type: integer
description: Milliseconds to wait before retrying (for rate limits)
details:
type: object
description: Additional error context
example:
code: AUTH_REQUIRED
message: Authentication required
http_status: 401
securitySchemes:
APIKey:
type: apiKey
in: header
name: X-API-Key
description: API key for machine-to-machine authentication
````