Skip to main content
GET
/
workflow-config
/
{id}
/
config
Get workflow config
curl --request GET \
  --url https://core.ravenna.ai/api/workflow-config/{id}/config \
  --header 'x-ravenna-api-token: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "isTemplate": true,
  "connections": [
    {
      "label": "<string>",
      "sourceId": "<string>",
      "targetId": "<string>",
      "criteria": "<any>",
      "id": "<string>"
    }
  ],
  "collectionId": "<string>",
  "steps": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "action": "<string>",
      "inputs": {},
      "metadata": {
        "groupId": "<string>",
        "isHidden": true,
        "isNotDeletable": true,
        "isNotDuplicable": true,
        "isNotReOrdable": true
      }
    }
  ],
  "author": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "image": "<string>"
  },
  "state": "Active",
  "reference": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

​
x-ravenna-api-token
string
header
required

Path Parameters

​
id
string
required

Response

Successful response

​
id
string
required
​
name
string
required
Minimum length: 1
​
isTemplate
boolean
required
​
connections
object[]
required
​
collectionId
string | null
required
​
steps
object[]
required
​
author
object | null
required
​
state
enum<string>
required
Available options:
Active,
Draft,
Deprovisioning,
Deleted
​
reference
string | null
required
​
createdAt
string
required
​
updatedAt
string
required
​
description
string | null
⌘I