Skip to main content
POST
/
workflows
/
v1
/
edges
Create Edge
curl --request POST \
  --url https://api-qa.interactly.ai/workflows/v1/edges \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "logical_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "workflow_id": "5eb7cf5a86d9755df3a6c593",
  "version_number": 0,
  "disabled": false,
  "miscellaneous": {},
  "source_node_logical_id": "<string>",
  "destination_node_logical_id": "<string>",
  "type": "direct"
}
'
{
  "edge": {
    "team_id": "<string>",
    "created_by": "<string>",
    "updated_by": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "_id": "5eb7cf5a86d9755df3a6c593",
    "edge_config": {
      "logical_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "workflow_id": "<string>",
      "version_number": 0,
      "disabled": false,
      "miscellaneous": {},
      "source_node_logical_id": "<string>",
      "destination_node_logical_id": "<string>",
      "type": "direct"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Body

application/json
​
logical_id
string | null

Unique identifier for the edge

​
name
string | null

Name of the edge

​
description
string | null

Description of the edge

​
workflow_id
string | null

The DB Object ID of the workflow this entity belongs to

Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

​
version_number
integer | null
default:0

Version number of the workflow this entity belongs to. 0 is the initial version (default).

​
disabled
boolean
default:false

If true, this entity will be disabled and will not execute its function. Useful for testing workflows without actually executing this specific entity

​
miscellaneous
Miscellaneous Config · object

Miscellaneous config data that can be used by the entity

​
source_node_logical_id
string | null

Logical ID of the source node for this edge

​
destination_node_logical_id
string | null

Logical ID of the target node for this edge

​
type
string
default:direct

Type of the edge. Expected to be always 'direct' for this base config

Allowed value: "direct"

Response

Successful Response

Response model for a single edge. Contains an EdgesModel object.

​
edge
EdgesModel · object
required

Single edge object