AI Agent
Authorization
Signed mode: every request is signed with your App Key/Secret. Header set:
| Name | Type | Required | Description |
|---|---|---|---|
Authorization | string · header | Required | The account Access Token from the OpenAPI dashboard — passed as the raw token (no Bearer prefix) and included in the signature calculation. |
X-Api-Key | string · header | Required | Your App Key. |
X-Timestamp | string · header | Required | Request timestamp in seconds (Unix epoch). |
X-Api-Signature | string · header | Required | HMAC-SHA256 signature. Format: HMAC-SHA256 SignedHeaders=authorization;x-api-key;x-timestamp, Signature=. |
List the Agents in the specified Workspace. The returned uid is the Agent identifier used in the Start Conversation endpoint path; only Agents with is_published set to true can start conversations.
Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspace_id | string | Required | Workspace ID |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | integer | Optional | Page number, starts at 1, default 1 |
limit | integer | Optional | Page size, default 20 |
Response
Response properties
| Name | Type | Required | Description |
|---|---|---|---|
agents | object[] | Required | Agent list |
└ uid | string | Required | Agent UID, used as the path parameter of [Start Conversation](/docs/ai/chat/conversation) |
└ name | string | Required | Agent name |
└ description | string | Optional | Agent description |
└ mode | string | Required | Agent mode, e.g. `chat` |
└ icon | string | Optional | Icon URL |
└ is_published | boolean | Required | Whether published; only published Agents can start conversations |
└ published_at | int64 | Optional | Publish time, Unix timestamp in seconds; 0 if unpublished |
└ created_at | int64 | Optional | Creation time, Unix timestamp in seconds |
└ updated_at | int64 | Optional | Last updated time, Unix timestamp in seconds |
total | int32 | Required | Total number of matching Agents |
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"agents": [
{
"uid": "ag_7d3f9b2c",
"name": "US Stock Analyst",
"description": "Answers US stock questions with market and fundamental data",
"mode": "chat",
"icon": "https://cdn.longbridge.com/icons/agent.png",
"is_published": true,
"published_at": 1742000000,
"created_at": 1741000000,
"updated_at": 1742001000
}
],
"total": 12
}
}Error code
See the Error Codes page for the full list of error codes.