Agent
API Authorization
NOTE
- To obtain the AUTH_TOKEN, please refer to the Authorization section and find the AUTH_TOKEN section.
- Please make sure that all API requests include the AUTH_TOKEN in the request header, as shown below:
SDK Authorization
NOTE
- Before integrating the SDK, please make sure that you have obtained the APP_ID and APP_KEY.
- To obtain the APP_ID and APP_KEY, please refer to the Authorization section and find the Obtain APP_ID & APP_KEY section.
Agent
API Request
- Example
- Field description
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| page | Integer | N | Page number (starting from 0) |
| size | Integer | N | Number of records per page returned |
| keyword | String | N | Keyword |
API Response
- Example
- Field description
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| pageNum | Integer | Y | Page number (starting from 0) |
| pageSize | Integer | Y | Number of records per page returned |
| total | Integer | Y | Total number of records |
| pages | Integer | Y | Total number of pages |
| currentPageTotal | Integer | Y | Number of records in the current page |
| content | Array<Object> | Y | Knowledge base list content |
| content.id | Integer | Y | Agent unique identifier |
| content.name | String | Y | Agent name |
| content.description | String | Y | Agent description |
| content.status | String | Y | Agent status ENABLED/DISABLED |
| content.createDatetime | Timestamp | Y | Agent creation time |
| content.updateDatetime | Timestamp | Y | Agent update time |
Agent Execute
Process Trigger
API Request
- Example
- Field description
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| agentId | Integer | Y | Agent unique identifier |
| query | String | Y | Agent conversation input |
API Response
- Example
- Field description
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| taskId | Integer | Y | Agent task ID |
| status | String | Y | Agent task status CREATED/IN_PROCESS/FAILED/FINISHED |
Process Detail
API Request
- Example
- Field description
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| id | Integer | Y | Agent task ID |
API Response
- Example
- Field description
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| taskId | Integer | Y | Agent task ID |
| status | String | Y | Agent task status CREATED/IN_PROCESS/FAILED/FINISHED |
| nodes | Array<Object> | Y | List of nodes |
| nodes.number | Integer | Y | Node number |
| nodes.id | Integer | Y | Node ID |
| nodes.status | String | Y | Node status CREATED/IN_PROCESS/FAILED/FINISHED |
| nodes.result | String | Y | Processing result of the node |
| nodes.costTime | Integer | Y | Time consumed to process the node |
| nodes.nodeInputs | Array<Object> | Y | List of input fields of the node |
| nodes.nodeInputs.name | String | Y | Field name of the node |
| nodes.nodeInputs.value | String | Y | Field value of the node |
| nodes.nodeInputs.type | String | Y | Field type of the node REFERENCE/INPUT |
| nodes.nodeOutputs | Array<Object> | Y | List of output fields of the node |
| nodes.nodeOutputs.name | String | Y | Field name of the node |
| nodes.nodeOutputs.value | String | Y | Field value of the node |
| nodes.nodeOutputs.type | String | Y | Field type of the node STRING,INTEGER,BOOLEAN,NUMBER,OBJECT, ARRAY_STRING,ARRAY_INTEGER, ARRAY_BOOLEAN,ARRAY_NUMBER, ARRAY_OBJECT |