Retrieve detailed information about a specific flow

• X-Verigram-Api-Key

  string

  header

  обязательно

  API key in the X-Verigram-Api-Key header

• X-Verigram-Api-Version

  string

  header

  обязательно

  Required API version header.

  Значение по умолчанию:

  2.0.0

Flow details

• flow_id

  string

  обязательно

  Unique identifier of the flow.

• consumer_id

  string

  обязательно

  Identifier of the consumer who owns the flow.

• vlink

  string

  обязательно

  A hosted URL where the user can access the flow's user interface. Useful for direct redirection or embedding in iframes/webviews.

• api_version

  string

  The version of the API used to create and process this flow.

• locale

  enum<string>

  Language code used for the flow's user interface.

  Одно из:

  kk

  ru

  en
• person_id

  string

  обязательно

  Identifier of a person associated with the session. Alphanumeric string.

• template

  FlowTemplate

  обязательно

  Flow template definition

  Показать поля
• test_flow

  boolean

  Indicates whether this is a test flow created with a sandbox API key.

• current_step_id

  string

  Identifier of the step currently being executed or waiting to be started.

• callback_url

  string<uri>

  URL where the user will be redirected upon completion of the flow.

• input_data

  FlowInputData

  Input data necessary for the steps of the pipeline

  Показать поля
• input_meta

  FlowInputMeta

  Metadata regarding the flow's initial environment.

  Показать поля
• template_id

  string

  Identifier of the template used for this flow configuration.

• created_at

  string<date-time>

  Timestamp when the flow was created.

• ttl

  integer

  Time-to-live for the flow in seconds.

• updated_at

  string<date-time>

  Timestamp of the last update to the flow's state.

• polled_at

  string<date-time>

  Timestamp when the flow's status was last polled by a client.

• started_at

  string<date-time>

  Timestamp when the flow execution actually started.

• current_step_started_at

  string<date-time>

  Timestamp when the current step execution began.

• ended_at

  string<date-time>

  Timestamp when the flow reached a final state (completed, failed, etc.).

• flow_status

  enum<string>

  обязательно

  The main status of a flow or a service. Helps to make a binary decision whether the flow/service was successful or not. If "pass" - the flow/service was successful, unsuccessful otherwise.

  Одно из:

  pass

  fail

  unknown
• end_cause

  enum<string>

  The reason why the flow ended. Returns "completed" when execution finishes without errors, "failed" when a server error or unhandled exception occurs, "timeout" when a specific step exceeds its allocated duration, or "disconnected" when the flow terminates due to a lost network connection or user intervention — a status applied automatically once the default five-minute inactivity threshold is reached, provided at least one service session was successfully initialized.

  Одно из:

  completed

  failed

  timeout

  disconnected