VEverbiflow
plays

Update Play Orchestration Session

post/api/plays/{play_id}/orchestration-sessions/{session_id}

Request

  • Base URL
    https://platform.verbiflow.com/api/bridge
  • URL
    https://platform.verbiflow.com/api/bridge/api/plays/{play_id}/orchestration-sessions/{session_id}
  • Auth
    • HTTP bearer and API key in header x-flage-org-id
    • or HTTP bearer and API key in header x-flage-org-slug

Path parameters

play_idstring required
session_idstring required

Request body

action'start' | 'heartbeat' | 'complete' | 'fail' required

Lifecycle transition to apply to the authoring session.

local_run_idstring nullable

Optional local workflow run id associated with the session.

Response

Successful Response

local_run_idstring nullable required

Associated local workflow run id when provided.

play_idstring required

Canonical Play id owning the session.

session_idstring required

Stable orchestration session id.

status'running' | 'completed' | 'failed' required

Current session lifecycle state.

Changes

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