Workflows

Endpointhttps://api.neuratel.ai

List workflows

GET

https://api.neuratel.ai

/v1/workflows

List workflows › query Parameters

skip

integer · min: 0

Default: 0

limit

integer · min: 1 · max: 100

Default: 50

List workflows › Responses

Successful Response

object[] · required

object · required

Pagination metadata in API responses.

Create a workflow

POST

https://api.neuratel.ai

/v1/workflows

Create a workflow › Request Body

name

string · minLength: 1 · maxLength: 255 · required

Create a workflow › Responses

Successful Response

id

string · uuid · required

organization_id

string · uuid · required

name

string · required

is_active

boolean · required

current_version

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

POST/v1/workflows

curl --request POST \
  --url https://api.neuratel.ai/v1/workflows \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "description": "string",
  "agent_id": "00000000-0000-0000-0000-000000000000"
}
'

shell

Example Request Body

{
  "name": "name",
  "description": "string",
  "agent_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "agent_id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "string",
  "is_active": true,
  "current_version": 0,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Get workflow with versions

GET

https://api.neuratel.ai

/v1/workflows/{workflow_id}

Get workflow with versions › path Parameters

workflow_id

string · uuid · required

Get workflow with versions › Responses

Successful Response

id

string · uuid · required

organization_id

string · uuid · required

name

string · required

is_active

boolean · required

current_version

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

object[]

Default: []

Delete a workflow

DELETE

https://api.neuratel.ai

/v1/workflows/{workflow_id}

Delete a workflow › path Parameters

workflow_id

string · uuid · required

Delete a workflow › Responses

Successful Response

No data returned

Update workflow metadata

PATCH

https://api.neuratel.ai

/v1/workflows/{workflow_id}

Update workflow metadata › path Parameters

workflow_id

string · uuid · required

Update workflow metadata › Request Body

Update workflow metadata › Responses

Successful Response

id

string · uuid · required

organization_id

string · uuid · required

name

string · required

is_active

boolean · required

current_version

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

PATCH/v1/workflows/{workflow_id}

curl --request PATCH \
  --url https://api.neuratel.ai/v1/workflows/:workflow_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "string",
  "description": "string",
  "agent_id": "00000000-0000-0000-0000-000000000000"
}
'

shell

Example Request Body

{
  "name": "string",
  "description": "string",
  "agent_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "agent_id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "string",
  "is_active": true,
  "current_version": 0,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Save a new graph revision (draft)

POST

https://api.neuratel.ai

/v1/workflows/{workflow_id}/graph

Save a new graph revision (draft) › path Parameters

workflow_id

string · uuid · required

Save a new graph revision (draft) › Request Body

object · required

Save a new graph revision (draft) › Responses

Successful Response

id

string · uuid · required

workflow_id

string · uuid · required

version_number

integer · required

status

string · enum · required

Enum values:

draft

published

archived

object · required

created_at

string · date-time · required

POST/v1/workflows/{workflow_id}/graph

curl --request POST \
  --url https://api.neuratel.ai/v1/workflows/:workflow_id/graph \
  --header 'Content-Type: application/json' \
  --data '
{
  "graph_data": {
    "nodes": [
      {
        "id": "id",
        "type": "conversation",
        "position": {
          "x": 0,
          "y": 0
        },
        "data": {}
      }
    ],
    "edges": [
      {
        "id": "id",
        "source": "source",
        "target": "target",
        "sourceHandle": "string",
        "label": "string",
        "condition": {
          "field": "string",
          "operator": "string",
          "value": "string"
        }
      }
    ],
    "start_node_id": "string",
    "global_nodes": [
      {
        "id": "id",
        "type": "conversation",
        "position": {
          "x": 0,
          "y": 0
        },
        "data": {}
      }
    ],
    "global_config": {}
  },
  "change_description": "string"
}
'

shell

Example Request Body

{
  "graph_data": {
    "nodes": [
      {
        "id": "id",
        "type": "conversation",
        "position": {
          "x": 0,
          "y": 0
        },
        "data": {}
      }
    ],
    "edges": [
      {
        "id": "id",
        "source": "source",
        "target": "target",
        "sourceHandle": "string",
        "label": "string",
        "condition": {
          "field": "string",
          "operator": "string",
          "value": "string"
        }
      }
    ],
    "start_node_id": "string",
    "global_nodes": [
      {
        "id": "id",
        "type": "conversation",
        "position": {
          "x": 0,
          "y": 0
        },
        "data": {}
      }
    ],
    "global_config": {}
  },
  "change_description": "string"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "workflow_id": "00000000-0000-0000-0000-000000000000",
  "version_number": 0,
  "status": "draft",
  "graph_data": {
    "nodes": [
      {
        "id": "id",
        "type": "conversation",
        "position": {
          "x": 0,
          "y": 0
        },
        "data": {}
      }
    ],
    "edges": [
      {
        "id": "id",
        "source": "source",
        "target": "target",
        "sourceHandle": "string",
        "label": "string",
        "condition": {
          "field": "string",
          "operator": "string",
          "value": "string"
        }
      }
    ],
    "start_node_id": "string",
    "global_nodes": [
      {
        "id": "id",
        "type": "conversation",
        "position": {
          "x": 0,
          "y": 0
        },
        "data": {}
      }
    ],
    "global_config": {}
  },
  "change_description": "string",
  "published_at": "2024-08-25T15:00:00Z",
  "created_at": "2024-08-25T15:00:00Z"
}

json

application/json

Publish a workflow revision

POST

https://api.neuratel.ai

/v1/workflows/{workflow_id}/publish

Publish a workflow revision › path Parameters

workflow_id

string · uuid · required

Publish a workflow revision › Request Body

version_number

integer · required

Publish a workflow revision › Responses

Successful Response

id

string · uuid · required

workflow_id

string · uuid · required

version_number

integer · required

status

string · enum · required

Enum values:

draft

published

archived

object · required

created_at

string · date-time · required

POST/v1/workflows/{workflow_id}/publish

curl --request POST \
  --url https://api.neuratel.ai/v1/workflows/:workflow_id/publish \
  --header 'Content-Type: application/json' \
  --data '
{
  "version_number": 0
}
'

shell

Example Request Body

{
  "version_number": 0
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "workflow_id": "00000000-0000-0000-0000-000000000000",
  "version_number": 0,
  "status": "draft",
  "graph_data": {
    "nodes": [
      {
        "id": "id",
        "type": "conversation",
        "position": {
          "x": 0,
          "y": 0
        },
        "data": {}
      }
    ],
    "edges": [
      {
        "id": "id",
        "source": "source",
        "target": "target",
        "sourceHandle": "string",
        "label": "string",
        "condition": {
          "field": "string",
          "operator": "string",
          "value": "string"
        }
      }
    ],
    "start_node_id": "string",
    "global_nodes": [
      {
        "id": "id",
        "type": "conversation",
        "position": {
          "x": 0,
          "y": 0
        },
        "data": {}
      }
    ],
    "global_config": {}
  },
  "change_description": "string",
  "published_at": "2024-08-25T15:00:00Z",
  "created_at": "2024-08-25T15:00:00Z"
}

json

application/json

DNC WhatsApp

List workflows

GET

https://api.neuratel.ai

/v1/workflows

List workflows › query Parameters

skip

integer · min: 0

Default: 0

limit

integer · min: 1 · max: 100

Default: 50

List workflows › Responses

Successful Response

object[] · required

object · required

Pagination metadata in API responses.

Create a workflow

POST

https://api.neuratel.ai

/v1/workflows

Create a workflow › Request Body

name

string · minLength: 1 · maxLength: 255 · required

Create a workflow › Responses

Successful Response

id

string · uuid · required

organization_id

string · uuid · required

name

string · required

is_active

boolean · required

current_version

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

Get workflow with versions

GET

https://api.neuratel.ai

/v1/workflows/{workflow_id}

Get workflow with versions › path Parameters

workflow_id

string · uuid · required

Get workflow with versions › Responses

Successful Response

id

string · uuid · required

organization_id

string · uuid · required

name

string · required

is_active

boolean · required

current_version

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

object[]

Default: []

Update workflow metadata

PATCH

https://api.neuratel.ai

/v1/workflows/{workflow_id}

Update workflow metadata › path Parameters

workflow_id

string · uuid · required

Update workflow metadata › Request Body

Update workflow metadata › Responses

Successful Response

id

string · uuid · required

organization_id

string · uuid · required

name

string · required

is_active

boolean · required

current_version

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

Save a new graph revision (draft)

POST

https://api.neuratel.ai

/v1/workflows/{workflow_id}/graph

Save a new graph revision (draft) › path Parameters

workflow_id

string · uuid · required

Save a new graph revision (draft) › Request Body

object · required

Save a new graph revision (draft) › Responses

Successful Response

id

string · uuid · required

workflow_id

string · uuid · required

version_number

integer · required

status

string · enum · required

Enum values:

draft

published

archived

object · required

created_at

string · date-time · required

Publish a workflow revision

POST

https://api.neuratel.ai

/v1/workflows/{workflow_id}/publish

Publish a workflow revision › path Parameters

workflow_id

string · uuid · required

Publish a workflow revision › Request Body

version_number

integer · required

Publish a workflow revision › Responses

Successful Response

id

string · uuid · required

workflow_id

string · uuid · required

version_number

integer · required

status

string · enum · required

Enum values:

draft

published

archived

object · required

created_at

string · date-time · required