Flows

Immediately enqueue one live execution on every device bound to the flow, regardless of whether its trigger is event-based, custom, or scheduled.

Supports an optional Idempotency-Key header (1-255 printable ASCII characters). The run identity is derived from the key, so a retry never starts a second run. Replays with the same key and an identical body return the original status and the original executionIds; a changed body under the same key returns 422 idempotency_key_reused.

post/flows/{flowId}/run

Request

  • Base URL
    https://api.mobilerun.ai
  • URL
    https://api.mobilerun.ai/flows/{flowId}/run
  • Auth
    HTTP bearer

Path parameters

flowIdstring uuid required

Headers

idempotency-keystring

Idempotency-Key: 1-255 printable ASCII characters. Same key with a different request body is a 422 idempotency_key_reused. A retryable in-flight duplicate is a 409 with Retry-After and x-should-retry: true; a terminal duplicate is a 409 with x-should-retry: false. A replay returns the current resource state with Idempotent-Replayed: true.

Example:b3f6a9f0-6f1a-4e9a-9e7a-9c9b6b6a5a3f

Request body

payloadobject
captureScreenshotsboolean

Record and keep this run's scripts.run screenshots (device.screenshot(save=True)) even without flow delivery. Used for a one-off proof run.

Response

Flow executions enqueued

Changes