AI Agent List Flow - nxtele/nxcloud-doc-en GitHub Wiki

List AI Agents

Query the list of available AI Agents and obtain the autoFlowId required by the task creation API.

API Information

  • URL: https://api-hk.nxlink.ai/openapi/aiagent/flow/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
name String No "Parcel Notification" AI Agent name, supports fuzzy matching
pageNumber Integer Yes 1 Page number. Default is 1
pageSize Integer Yes 10 Page size. Default is 10, maximum is 1000

Notes

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

Request Example

{
  "name": "Parcel",
  "pageNumber": 1,
  "pageSize": 10
}

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 AI Agent list

list Element

Parameter Type Description
autoFlowId Long AI Agent ID to be used as autoFlowId when creating a task
name String AI Agent name
desc String Description
status Integer Flow enabled/draft status. 0 = Disabled, 1 = Enabled, 2 = Draft
engineModel Integer Engine mode. 0 = Normal engine, 1 = AI engine (see EngineTypeEnum)
engineVersion String AI engine version tier. Supported values: basic, standard, pro
language String Language
voiceId Integer Voice ID
voiceName String Voice name
version Integer Version number
userId Long Creator ID
userName String Creator account
createTime String Creation time
updateTime String Update time

Field Reference

Parameter Values Description
status 0 / 1 / 2 Flow enabled/draft status. 0 = Disabled, 1 = Enabled, 2 = Draft
engineModel 0 / 1 Engine mode. 0 = Normal engine, 1 = AI engine
engineVersion basic / standard / pro AI engine version tier

Note: The actual response field names are engineModel and engineVersion, which correspond to engine mode and AI engine version tier.

Response Example

Success Example

{
  "code": 0,
  "message": "success",
  "traceId": "432ed6e675d84f61b526d624d5ceef1a",
  "data": {
    "total": 84,
    "pageNumber": 1,
    "pageSize": 10,
    "list": [
      {
        "autoFlowId": 446,
        "name": "Parcel Arrival Notification",
        "desc": "Used for parcel arrival and pre-delivery notification scenarios",
        "status": 1,
        "engineModel": 1,
        "engineVersion": "standard",
        "language": "zh-CN",
        "voiceId": 9,
        "voiceName": "Chinese - Male - Deep Tone",
        "version": 134,
        "userId": 10001,
        "userName": "demo_user_001",
        "createTime": "2025-06-05 14:26:41",
        "updateTime": "2026-03-25 11:29:05"
      },
      {
        "autoFlowId": 197,
        "name": "Marketing Bot",
        "desc": "Used for campaign promotion and membership outreach scenarios",
        "status": 1,
        "engineModel": 1,
        "engineVersion": "standard",
        "language": "zh-CN",
        "voiceId": 9,
        "voiceName": "Chinese - Female - Warm Tone",
        "version": 132,
        "userId": 10002,
        "userName": "demo_user_002",
        "createTime": "2025-03-01 10:00:00",
        "updateTime": "2026-03-25 09:00:00"
      }
    ]
  }
}

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