GET
/
apps
/
{app_id}
/
workflows
/
{workflow_id}
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "app": {
    "id": "<string>",
    "name": "<string>",
    "verified": true
  },
  "version": {
    "id": "<string>",
    "app_id": "<string>",
    "workflow_id": "<string>",
    "description": "<string>",
    "version": 123,
    "rollback_version": 123,
    "notes": "<string>",
    "created_by": {
      "id": "<string>",
      "name": "<string>"
    },
    "created_at": "2023-12-25",
    "key": "<string>",
    "input": {},
    "input_default": {},
    "input_options": {
      "display": {
        "field": "inline",
        "container": "grid",
        "hidden": true
      }
    },
    "steps": [
      {
        "type": "note",
        "key": "<string>",
        "display": "expanded",
        "conditional": "<string>",
        "loop": "<string>",
        "throw_on_error": true,
        "input_connected": true,
        "destinations": [
          "<string>"
        ],
        "position": [
          123
        ],
        "size": [
          101
        ],
        "auto": {
          "provider": "<string>",
          "model": "<string>",
          "temperature": 1
        },
        "note": "<string>"
      }
    ]
  },
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "color": "<string>",
      "app_id": "<string>",
      "created_at": "2023-12-25",
      "updated_at": "2023-12-25"
    }
  ],
  "tests_stats": {
    "total_count": 123,
    "running_count": 123,
    "cancelled_count": 123,
    "passing_count": 123,
    "failing_count": 123,
    "expectations_failing_count": 123,
    "expectations_passing_count": 123
  },
  "template_id": "<string>",
  "runs_count": 0,
  "retention": {
    "max_age_in_seconds": 3600,
    "preserve_on_failure": true
  },
  "enabled": true,
  "deleted": false,
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25",
  "key": "<string>",
  "input": {},
  "input_default": {},
  "input_options": {
    "display": {
      "field": "inline",
      "container": "grid",
      "hidden": true
    }
  },
  "steps": [
    {
      "type": "note",
      "key": "<string>",
      "display": "expanded",
      "conditional": "<string>",
      "loop": "<string>",
      "throw_on_error": true,
      "input_connected": true,
      "destinations": [
        "<string>"
      ],
      "position": [
        123
      ],
      "size": [
        101
      ],
      "auto": {
        "provider": "<string>",
        "model": "<string>",
        "temperature": 1
      },
      "note": "<string>"
    }
  ]
}

Path Parameters

​
app_id
string
required

The ID of the app

​
workflow_id
string
required

The ID of the workflow

Response

200 - application/json

Detailed information about a workflow

​
id
string
required

Unique identifier for the workflow

​
name
string
required

Name of the workflow

​
description
string | null
required

Description of the workflow

​
app
object
required

Associated app with the workflow

​
version
object | null
required

Current version of the workflow

​
tags
object[]
required

Tags associated with the workflow

​
template_id
string | null
required

Unique identifier for the template

​
runs_count
number
required

Number of runs of the workflow

Example:

0

​
retention
object | null
required

Data retention policy for the run

Example:
{
  "max_age_in_seconds": 3600,
  "preserve_on_failure": true
}
​
enabled
boolean
required

Indicates if the workflow is enabled

Example:

true

​
deleted
boolean
required

Indicates if the workflow is deleted

Example:

false

​
created_at
string<date> | null
required

Creation date of the workflow

​
updated_at
string<date> | null
required

Last update date of the workflow

​
key
string
required

Unique key for the workflow version

​
input
object
required

The definition of the input fields Input definition of the workflow

​
input_default
object | null
required

Default config input values of the workflow

​
input_options
object | null
required

Input options of the workflow

​
steps
object[]
required

Steps of the workflow at the time this version was deployed

​
tests_stats
object | null

Statistics of the workflow tests