Skip to main content
GET
Get a Workflow's API contract

Authorizations

Authorization
string
header
required

API key with the vd_sk_ prefix. Create keys from Settings, API Keys in the dashboard.

Path Parameters

slug
string
required

The workflow's slug (shown on its API tab).

Response

The workflow's contract.

id
string
slug
string
name
string
description
string | null
status
string
input_schema
object[]
input_json_schema
object

JSON Schema (draft 2020-12) of inputs.

output
string

What outputs holds, in one sentence.

output_json_schema
object
run_json_schema
object
trigger
object

The API trigger node: {type: "api_trigger", node}.

reliability
object
api_endpoint
string
Example:

"/v1/workflows/test-workflow-api/run"

runs_endpoint
string
run_status_endpoint
string
mcp_tool
string
Example:

"workflow_test-workflow-api"