Skip to main content

Build your API

How to build your API​

To start building your first API endpoint you need to understand how the endpoint's flow works. the endpoint will always start from the start node so you need to click on its connector and add your first node. you can also use the next property to change nodes triggers.

Deploy and run​

Before you run your API you need to click on Save and deploy to deploy the changes you made, after that you can click on Run to start your first run.

Sending parameters​

You can click on Run options and add parameters to send to your API, example:

{
    "endpoint": "main",
    "parameters": {
      "input": "hello"
    }
}

Now you can get the value of this parameter from any node's property using the follow syntax: koxy.get.{input}. Learn more about Dynamic variables