AI Agent List Route

List Routes

Query the list of available routes and obtain the routeId required by the task creation API.

---

API Information

• URL: https://api-hk.nxlink.ai/openapi/aiagent/route/list
• Method: POST
• Content-Type: application/json
• Authentication Required: Yes

---

🌐 Service Endpoints

NXLink is deployed across multiple global regions. Please select the appropriate service endpoint based on your business location.

Code	Region	NXLink Website	API Gateway
APAC	Hong Kong	https://app.nxlink.ai	https://api-hk.nxlink.ai
AMER	Americas	https://chl-nxlink.nxcloud.com	https://chl-api.nxlink.ai
APAC(IDN)	Indonesia	https://idn.nxlink.ai	https://api-idn.nxlink.ai

---

Request Parameters

Header Parameters

Parameter	Type	Required	Example Value	Description
accessKey	String	Yes	AK-6230339248928541113-2133	User identity identifier
ts	String	Yes	1655710885431	Current request timestamp in milliseconds. The server allows a maximum time difference of 60 seconds
bizType	String	Yes	100	Business type. Fixed value: 100
action	String	Yes	nxai	Business action. Fixed value: nxai
sign	String	Yes	6e9506557d1f289501d333ee2c365826	API request signature. See common conventions, Signature Algorithm

---

Body Parameters

Parameter	Type	Required	Example Value	Description
routeName	String	No	"MX-Router"	Route name, supports fuzzy matching
pageNumber	Integer	Yes	1	Page number. Default is 1
pageSize	Integer	Yes	100	Page size. Default is 100, maximum is 1000

---

Notes

1. Use the routeId returned by this API as the routeId field in the task creation API.

---

Request Example

{
  "routeName": "MX",
  "pageNumber": 1,
  "pageSize": 100
}

Response Parameters

Parameter	Type	Description
code	Integer	Result code
message	String	Result message
traceId	String	Trace ID for request tracking
data	Object	Response payload

---

data Object

Parameter	Type	Description
total	Integer	Total number of records
pageNumber	Integer	Current page number
pageSize	Integer	Page size
list	Array	Route list

---

list Element

Parameter	Type	Description
routeId	String	Route ID to be used as routeId when creating a task
routeName	String	Route name
routeType	Integer	Route type. 0 = Bot-built, 1 = Third-party, 2 = CC route
isDefault	Integer	Default route flag. 1 = default, 0 = non-default

---

routeType Reference

Value	Description
0	Bot-built
1	Third-party
2	CC route

---

Response Example

Success Example

{
  "code": 0,
  "message": "success",
  "traceId": "658CCE52391B4869B13FDD432658EDC8",
  "data": {
    "total": 50,
    "pageNumber": 1,
    "pageSize": 100,
    "list": [
      {
        "routeId": "R-123-123",
        "routeName": "MX-Router",
        "routeType": 2,
        "isDefault": 1
      },
      {
        "routeId": "R-456-789",
        "routeName": "Local-Display-Router",
        "routeType": 1,
        "isDefault": 0
      }
    ]
  }
}

Error Codes

Code	Description
1001	Authentication failed (missing public parameters)
1002	Authentication failed (parameter error)
1003	Authentication failed (invalid signature)
1004	Authentication failed (timestamp expired)
1005	Authentication failed (insufficient authority)
20000	Business Error