Skip to main content
GET
/
workflow-config
/
{workflowId}
/
steps
/
{stepId}
Get step
curl --request GET \
  --url https://core.ravenna.ai/api/workflow-config/{workflowId}/steps/{stepId} \
  --header 'x-ravenna-api-token: <api-key>'
{
  "id": "<string>",
  "title": "<string>",
  "description": "<string>",
  "action": {
    "name": "<string>",
    "type": "Action",
    "group": "<string>",
    "description": "<string>",
    "title": "<string>",
    "app": "<string>",
    "inputs": [
      {
        "label": "<string>",
        "key": "<string>",
        "placeholder": "<string>",
        "span": 123,
        "type": "text",
        "resourceType": "organization"
      }
    ],
    "outputs": [
      {
        "label": "<string>",
        "key": "<string>",
        "placeholder": "<string>",
        "span": 123,
        "type": "text",
        "resourceType": "organization"
      }
    ]
  },
  "inputs": {},
  "metadata": {
    "groupId": "<string>",
    "isHidden": true,
    "isNotDeletable": true,
    "isNotDuplicable": true,
    "isNotReOrdable": true
  },
  "suggestions": [
    {
      "field": {
        "label": "<string>",
        "key": "<string>",
        "placeholder": "<string>",
        "span": 123,
        "type": "text",
        "resourceType": "organization"
      },
      "stepId": "<string>"
    }
  ],
  "inputsWithSuggestions": {}
}

Authorizations

x-ravenna-api-token
string
header
required

Path Parameters

workflowId
string
required
stepId
string
required

Query Parameters

suggestions
boolean

Response

id
string
required
title
string
required
action
object
required
inputs
object
required
description
string | null
metadata
object
suggestions
object[]
inputsWithSuggestions
object