Skip to content
Proud to collaborate with Microsoft for Startups

media.artifact.request-review ​

Create a Staff ActorOutboxEnvelope for GeneratedArtifact inbox review, stamp approval_envelope_id on the artifact, and fan out to inbox connectors.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-media
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
workflow_run_idstringNo—Parent DAG workflow run id (engine-injected when used as a step)
organization_uuidstringYes——
artifact_uuidstringYes——
actor_uuidstringYes—Staff actor that owns the inbox item / receives the envelope
titlestringNo——
reasonstringNo——
suppress_dispatchbooleanNo——
connector_uuidstringNo——
idempotency_keystringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
workflow_run_idstringNo—Parent DAG workflow run id (engine-injected when used as a step)
organization_uuidstringYes——
artifact_uuidstringNo——
actor_uuidstringYes—Staff actor that owns the inbox item / receives the envelope
titlestringNo——
reasonstringNo——
suppress_dispatchbooleanNo——
connector_uuidstringNo——
idempotency_keystringNo——
approval_envelope_idstringNo——
approval_envelope_uuidstringNo——
createdbooleanNo——
dedupedbooleanNo——
dispatch_summaryjsonNo——
artifactjsonNo——
failure_reasonstringNo—Engine-stamped human-readable failure reason
failed_atstringNo—ISO timestamp when the workflow failed
failed_at_statestringNo—Engine-stamped state when the workflow failed
failed_stepstringNo—Engine-stamped step name (DAG path)
failed_layerintegerNo—Engine-stamped layer index (DAG path)
errorstringNo—Engine-stamped exception message
error_typestringNo—Engine-stamped exception class name
completed_atstringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

Outcomes ​

OutcomeTypeDescriptionState Data Keys
completedSUCCESSMedia atom completed successfullycompleted_at
failedFAILUREMedia atom failedfailure_reason, error, error_type

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "media.artifact.request-review",
  "initial_data": {
    "organization_uuid": "value",
    "artifact_uuid": "value",
    "actor_uuid": "value"
  }
}