Get workflow variable catalog

Typed variables available to a workflow definition: trigger inputs and the outputs of earlier steps.

POST /workflows/variable-catalog

Get workflow variable catalog

cURL

curl --request POST \
  --url https://api.pineyard.ai/workflows/variable-catalog \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "definition": {
    "definitionVersion": 1,
    "nodes": [
      {
        "id": "start",
        "type": "start",
        "position": {
          "x": 0,
          "y": 0
        },
        "data": {}
      },
      {
        "id": "end_ok",
        "type": "end",
        "position": {
          "x": 0,
          "y": 1
        },
        "data": {
          "label": "Done"
        }
      }
    ],
    "edges": [
      {
        "id": "e1",
        "source": "start",
        "target": "end_ok"
      }
    ]
  }
}
'

200

{
  "triggerInput": {
    "name": "<string>",
    "type": "string",
    "description": "<string>",
    "allowedValues": [
      "<string>"
    ],
    "open": true,
    "children": "<array>"
  },
  "producers": [
    {
      "nodeId": "<string>",
      "label": "<string>",
      "output": {
        "name": "<string>",
        "type": "string",
        "description": "<string>",
        "allowedValues": [
          "<string>"
        ],
        "open": true,
        "children": "<array>"
      }
    }
  ],
  "availabilityByNode": {},
  "conditionOperatorsByType": {}
}

Required scope: workflows.view

Requires workflows enabled for your workspace. Otherwise the request is refused; see Errors.

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Body

application/json

definition · object · required

Opaque workflow definition JSON object. Graph validation is performed by the workflow validator.

Show child attributes

Example:

{
  "definitionVersion": 1,
  "nodes": [
    {
      "id": "start",
      "type": "start",
      "position": { "x": 0, "y": 0 },
      "data": {}
    },
    {
      "id": "end_ok",
      "type": "end",
      "position": { "x": 0, "y": 1 },
      "data": { "label": "Done" }
    }
  ],
  "edges": [
    {
      "id": "e1",
      "source": "start",
      "target": "end_ok"
    }
  ]
}

Response

200

application/json

OK

triggerInput · object · required

Show child attributes

producers · object[] · required

Show child attributes

availabilityByNode · object · required

Show child attributes

conditionOperatorsByType · object · required

Show child attributes