Nodeflow Logo
  • features
    • Visual Programming
    • Main Features
  • pricing
    • Lite
    • Standard
    • Premium
    • Enterprise
  • recources
    • Examples
    • Documentation
    • API
  • support
    • FAQ
    • Contact Support
    • Help
  • company
    • About Us
    • Contact Us
API Documentation
  • Get All Nodes
  • Get Node by ID
  • Create a Node
  • Update a Node
  • Delete a Node

API Documentation

Below you will find information on how to use our API endpoints.

1. Get All Nodes

URL: /api

Method: GET

Authorization: Bearer Token

Response:

[
    {
        "id": "1",
        "title": "Node 1",
        "details": "Details of Node 1",
        "color": "#ffffff",
        "x": 100,
        "y": 200,
        "width": 100,
        "height": 100,
        "scale": 1,
        "z": 0
    },
    {
        "id": "2",
        "title": "Node 2",
        "details": "Details of Node 2",
        "color": "#ff0000",
        "x": 200,
        "y": 300,
        "width": 150,
        "height": 150,
        "scale": 1,
        "z": 1
    }
]

2. Get a Node by ID

URL: /api/:id

Method: GET

Authorization: Bearer Token

URL Params: id=[string]

Response:

{
    "id": "1",
    "title": "Node 1",
    "details": "Details of Node 1",
    "color": "#ffffff",
    "x": 100,
    "y": 200,
    "width": 100,
    "height": 100,
    "scale": 1,
    "z": 0
}

3. Create a Node

URL: /api

Method: POST

Authorization: Bearer Token

Body Params:

{
    "title": "New Node",
    "details": "Details of the new node",
    "color": "#000000",
    "x": 50,
    "y": 50,
    "width": 100,
    "height": 100,
    "scale": 1,
    "z": 0
}

Response:

{
    "id": "3",
    "title": "New Node",
    "details": "Details of the new node",
    "color": "#000000",
    "x": 50,
    "y": 50,
    "width": 100,
    "height": 100,
    "scale": 1,
    "z": 0
}

4. Update a Node

URL: /api/:id

Method: PATCH

Authorization: Bearer Token

URL Params: id=[string]

Body Params:

{
    "title": "Updated Node Title",
    "details": "Updated details",
    "color": "#ff0000",
    "x": 150,
    "y": 250,
    "width": 120,
    "height": 120,
    "scale": 1.5,
    "z": 1
}

Response:

{
    "id": "1",
    "title": "Updated Node Title",
    "details": "Updated details",
    "color": "#ff0000",
    "x": 150,
    "y": 250,
    "width": 120,
    "height": 120,
    "scale": 1.5,
    "z": 1
}

5. Delete a Node

URL: /api/:id

Method: DELETE

Authorization: Bearer Token

URL Params: id=[string]

Response:

{
    "message": "Node deleted successfully"
}

Company

  • About Us
  • Careers

Products

  • Features
  • Pricing
  • Examples

Resources

  • Help Center
  • Documentation
  • API Reference

Contact Us

  • Email: nodeflow.systems@gmail.com

Follow Us

  • LinkedIn
  • @NodeflowAI

© 2024 Nodeflow Inc. All rights reserved.