Workflow Control Plane

Create a workflow

Register a new workflow from an external orchestrator (LangChain, LangGraph, CrewAI). Returns a workflow_id to use for subsequent step gate checks.

post/api/v1/workflows

Request

Request body

workflow_namestring required

Human-readable name for the workflow

source'langgraph' | 'langchain' | 'crewai' | 'external'

Source orchestrator

trace_idstring

External trace ID for correlation with Langsmith, Datadog, or OpenTelemetry

metadataobject

Additional workflow metadata

Example request

{
  "workflow_name": "code-review-pipeline",
  "trace_id": "langsmith-trace-abc123"
}

Response

Workflow created

workflow_idstring

Unique workflow identifier

workflow_namestring
status'in_progress' | 'completed' | 'aborted' | 'failed'
trace_idstring

External trace ID for correlation with Langsmith, Datadog, or OpenTelemetry

started_atstring date-time
created_atstring date-time

When the workflow row was inserted. Distinct from started_at because workflows can be created in a staged-but-not-running state.

source'langgraph' | 'langchain' | 'crewai' | 'external'

Echoes the request's source so callers don't need a separate read after creation to learn which orchestrator owns the workflow.

Example response

{
  "workflow_id": "wf_41231a72-9b0c-4f5e-8a13-6d2e0c7b4f91",
  "trace_id": "langsmith-trace-abc123"
}

Changes

No recorded changes to this operation across all 1 revision of this API.