Media status flows
The statuses media moves through before the whole workspace sees it, and who may move it — the review pipeline behind the media library.
List flows
Returns the workspace's media status flows, each with its statuses. At most one is active at a time.
query Parameters
cursor^[A-Za-z0-9_-]+$limitoffsetsm_activesort^-?[a-z0-9_]+$Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List flows › Responses
Success
sm_idsm_activesm_createdsm_updatedsm_object_criteriaThe moves the machine allows. roles and users are alternatives — holding one of the roles or being one of the users is enough — and naming neither leaves the move open to anyone who can write the record.
sm_metadataThe flow's statuses, in display order.
Create a flow
Defines the statuses media moves through and who may move it. Answers 409 while an active flow exists — update or delete that one instead.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Create a flow › Responses
Created
sm_idsm_activesm_createdsm_updatedsm_object_criteriaThe moves the machine allows. roles and users are alternatives — holding one of the roles or being one of the users is enough — and naming neither leaves the move open to anyone who can write the record.
sm_metadataThe flow's statuses, in display order.
Get a flow
Returns the flow with its statuses, its transitions, and the roles each transition requires.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get a flow › Responses
Success
sm_idsm_activesm_createdsm_updatedsm_object_criteriaThe moves the machine allows. roles and users are alternatives — holding one of the roles or being one of the users is enough — and naming neither leaves the move open to anyone who can write the record.
sm_metadataThe flow's statuses, in display order.
Update a flow
Replaces the flow's statuses and transitions. Files already sitting in a status the new definition drops keep that value until something moves them.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Update a flow › Responses
Success
sm_idsm_activesm_createdsm_updatedsm_object_criteriaThe moves the machine allows. roles and users are alternatives — holding one of the roles or being one of the users is enough — and naming neither leaves the move open to anyone who can write the record.
sm_metadataThe flow's statuses, in display order.
Delete a flow
Stops media being governed. Files keep the status they are in.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Delete a flow › Responses
Success. No content.