Skip to main content
POST
Create workflow

Authorizations

Authorization
string
header
required

Bearer authentication using a factapi-issued API key (ffy_<env>_<base32_uuid><base62_random>). Cookie-based sessions are accepted automatically by user-facing endpoints but are not surfaced as an OpenAPI auth scheme.

Body

application/json
name
string
required

Human-readable workflow name.

Example:

"Employment Agreement Extraction"

rubrics
object[]
required

Claim slot definitions to create with this workflow.

description
string
default:""

Human-readable workflow description.

body_md
string
default:""

Markdown template body with {{slot_name}} placeholders.

Response

Workflow created.

id
string
required

Workflow TypeID (wfl_…)

Example:

"wfl_01j9z0000000000000000000a0"

name
string
required

Human-readable workflow name.

description
string
required

Human-readable workflow description. Empty string when unset.

body_md
string
required

Markdown template body. Claim slot placeholders use {{slot_name}} syntax.

rubrics
object[]
required

Claim slot definitions for this workflow, in creation order.

created_at
string<date-time>
required
active_revision_id
string | null

TypeID (wrev_…) of the workflow's currently active revision. Null when no revision is active (draft-only, never activated).