API Documentation Template (For Creators)

You can use the following example as a reference when writing your API documentation. Replace field names, types, and descriptions with those specific to your workflow.

🔗 Request URL

POST https://api.yourdomain.com/api_trigger/{trigger_id}/run

✅ Replace {trigger_id} with your actual trigger ID.

⚠️Creating a Trigger in the Start Node generates a user-specific API endpoint for sending requests; the platform will return results via your callback URL. Each endpoint is unique per user — keep it secure to prevent unauthorized access.

---

📥 Request Body

{
    "data":{
        "topic":"skydiving",
        "style":"serious"
    },
    "callbackUrl":"http://youAddress/receive"
}

---

📑 Parameter Descriptions

Parameter Name	Type	Example	Description
data	dict	{ "topic":"skydiving", "style":"serious"}	If a workflow input parameter is not provided, the default value defined in the input node will be used.
callback_url	string	"https://..."	Public URL to receive the result.

✅callback_url is required. After the workflow finishes, the platform will send a POST request to this address with the execution result.

✅ If callback_url is inaccessible or returns an error, the workflow will still execute as normal — including actions such as posting a tweet. However, you will not receive the execution result.

---

📬 Callback Payload Example

{
  "request_id": "fb4090a7-d607-4c4c-b00b-7d8c77565fe3",
  "status": "success",
  "result": {
    "twitter_content": "Skydiving is a conversation between courage and nature — feel the wind and freedom, gaze down at the beautiful Earth, and challenge the limits of yourself. Join our journey and discover true adventure!
 #Skydiving #Travel #ExtremeSports #Tour",
    "twitter_url": "https://x.com/user/status/xxxxxxxx"
  },
  "request_data": {
    "topic": "skydiving",
    "style": "serious"
  }
}

---

🧪 Example cURL Request

curl -X POST https://api.yourdomain.com/api_trigger/trigger_123/run \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "topic": "xxx",
      "style": "yyy"
    },
    "callback_url": "https://yourdomain.com/api/callback"
  }'

---

✅ Notes for Creators

• This is only a template. Be sure to update field names and descriptions based on your actual workflow inputs.

• Clearly specify your field types (e.g., string, number, boolean).

• Use real, valid example values to help API users understand how to call your workflow.

---

📌 Additional Notes

• The platform does not currently enforce authentication, so secure your endpoint manually.

• Use HTTPS for both requests and callbacks to ensure data security.

• For each request, the platform returns a unique request_id to facilitate logging and ensure idempotent processing.

• Error Handling & Retry Policy

  • If the platform fails to call your callback_url (e.g., due to connection issues, timeouts, or 5xx server errors), it will automatically retry up to 3 times with increasing delays:

  • 1st attempt: after 5 seconds

  • 2nd attempt: after 10 seconds

  • 3rd attempt: after 20 seconds