WorkflowBodyV1

Fields

10 fields

base · required

string

deadline_seconds

integer

description

string or null

edges

array of WorkflowEdgeV1

loops

array of WorkflowLoopV1

name · required

string

retry_policy

WorkflowRetryPolicyV1

review_policy

string

steps · required

array of WorkflowStepV1

workflow_id · required

string

Raw schema (JSON)

{
  "additionalProperties": false,
  "properties": {
    "base": {
      "enum": [
        "offline",
        "deep",
        "live"
      ],
      "title": "Base",
      "type": "string"
    },
    "deadline_seconds": {
      "default": 1500,
      "maximum": 86400,
      "minimum": 1,
      "title": "Deadline Seconds",
      "type": "integer"
    },
    "description": {
      "anyOf": [
        {
          "maxLength": 4000,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Description"
    },
    "edges": {
      "items": {
        "$ref": "#/components/schemas/WorkflowEdgeV1"
      },
      "maxItems": 300,
      "title": "Edges",
      "type": "array"
    },
    "loops": {
      "items": {
        "$ref": "#/components/schemas/WorkflowLoopV1"
      },
      "maxItems": 50,
      "title": "Loops",
      "type": "array"
    },
    "name": {
      "maxLength": 120,
      "minLength": 1,
      "title": "Name",
      "type": "string"
    },
    "retry_policy": {
      "$ref": "#/components/schemas/WorkflowRetryPolicyV1"
    },
    "review_policy": {
      "default": "human_required",
      "enum": [
        "human_required",
        "human_required_plus_auto_reviewer"
      ],
      "title": "Review Policy",
      "type": "string"
    },
    "steps": {
      "items": {
        "$ref": "#/components/schemas/WorkflowStepV1"
      },
      "maxItems": 100,
      "minItems": 1,
      "title": "Steps",
      "type": "array"
    },
    "workflow_id": {
      "maxLength": 80,
      "minLength": 3,
      "pattern": "^(?:wf\\.[a-z0-9_.-]+|offline|deep|live)$",
      "title": "Workflow Id",
      "type": "string"
    }
  },
  "required": [
    "workflow_id",
    "name",
    "base",
    "steps"
  ],
  "title": "WorkflowBodyV1",
  "type": "object"
}

Used by endpoints

2 endpoints send or return this schema, on its own or inside another schema.

• POST /api/v1/projects/{project_id}/workflows — Create Workflow
• PUT /api/v1/projects/{project_id}/workflows/{workflow_id} — Update Workflow

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON