Skip to main content
POST
/
apps
/
{app_id}
/
workflows
/
{workflow_id}
/
tests
Create a Test
curl --request POST \
  --url https://api.example.com/apps/{app_id}/workflows/{workflow_id}/tests \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "status": "PASSED",
  "step_key": "<string>",
  "expectations_passing_count": 123,
  "expectations_failing_count": 123,
  "workflow_id": "<string>",
  "run": {
    "id": "<string>",
    "input": {},
    "output": {},
    "status": "RUNNING",
    "origin": "WORKFLOW",
    "started_at": "2023-12-25",
    "ended_at": "2023-12-25",
    "app_id": "<string>",
    "workflow_app_id": "<string>",
    "workflow_id": "<string>",
    "workflow_version_draft": {
      "key": "<string>",
      "input": {},
      "input_default": {},
      "input_options": {
        "display": {
          "field": "inline",
          "container": "grid",
          "hidden": true
        }
      },
      "steps": [
        {
          "type": "note",
          "key": "<string>",
          "note": "<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
          }
        }
      ]
    },
    "workflow_version": {
      "id": "<string>",
      "app_id": "<string>",
      "workflow_id": "<string>",
      "description": "<string>",
      "version": 123,
      "notes": "<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>",
          "note": "<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
          }
        }
      ],
      "rollback_version": 123,
      "created_by": {
        "id": "<string>",
        "name": "<string>"
      }
    },
    "created_at": "2023-12-25",
    "updated_at": "2023-12-25",
    "result": "<unknown>",
    "error": "<string>",
    "collection_id": "<string>",
    "record_id": "<string>",
    "version": 123,
    "usage": {
      "total": 123,
      "steps": {},
      "calls": [
        {
          "id": "<string>",
          "total": 123,
          "calls": [
            "<unknown>"
          ]
        }
      ]
    },
    "retention": {
      "max_age_in_seconds": 3600,
      "preserve_on_failure": true
    },
    "retention_due_at": "2023-12-25"
  },
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25",
  "input": {},
  "input_default": {},
  "input_context": {},
  "expectations": [
    {
      "key": "<string>",
      "name": "<string>",
      "expectation_id": "<string>",
      "script": "<string>",
      "output": "<unknown>",
      "logs": [
        "<unknown>"
      ],
      "status": "PASSED"
    }
  ]
}

Path Parameters

​
app_id
string
required

The ID of the app

​
workflow_id
string
required

The ID of the workflow

Query Parameters

​
verbose
enum<string>[]
Available options:
all

Body

Data to create a new workflow test

​
name
string
required

Name of the workflow test to be created (max 256 characters)

Required string length: 1 - 256

Response

200 - application/json

Detailed information about a workflow test

​
id
string
required

Unique identifier for the workflow test

​
name
string
required

Name of the workflow test

​
status
enum<string>
required

Status of the workflow test

Available options:
DRAFT,
CANCELLED,
RUNNING,
FAILED,
PASSED
Example:

"PASSED"

​
step_key
string | null
required

Starting step key for the workflow test

​
expectations_passing_count
number
required

Number of passing expectations

​
expectations_failing_count
number
required

Number of failing expectations

​
workflow_id
string
required

Identifier of the associated workflow

​
run
object
required

Run details of the workflow test

​
created_at
string<date> | null
required

Creation date of the workflow test

​
updated_at
string<date> | null
required

Last update date of the workflow test

​
input
object

Input values for the workflow test

​
input_default
object

Default input values for the workflow test

​
input_context
object

Default input values for the workflow test

​
expectations
object[]

List of expectations that will be executed for the workflow test