diff --git a/docs/en/docs/ai/agents.md b/docs/en/docs/ai/agents.md new file mode 100644 index 00000000..df5131a9 --- /dev/null +++ b/docs/en/docs/ai/agents.md @@ -0,0 +1,104 @@ +--- +slug: agents +title: Public Agents +sidebar_position: 0.5 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +List all publicly available Agents on the platform — the same catalog shown on the Explore page. The returned `uid` is the Agent identifier used in the [Start Conversation](/docs/ai/chat/conversation) endpoint path. + +Unlike [Agents in Workspace](/docs/ai/workspace/agents), this endpoint is not scoped to a Workspace: it returns every Agent that is published and publicly shared. + +## Request + + + + + + +
HTTP MethodGET
HTTP URL/v1/ai/agents
+ +### Query Parameters + +| Name | Type | Required | Description | +| ----- | ------ | -------- | ------------------------------------ | +| page | int32 | NO | Page number, starts at 1, default 1 | +| limit | int32 | NO | Page size, default 20, maximum 50 | +| name | string | NO | Fuzzy search by Agent name | + +### Request Example + + + + +```bash +curl "https://openapi.longbridge.com/v1/ai/agents?page=1&limit=20" \ + -H "Authorization: Bearer " \ + -H "Accept: application/json" +``` + + + + +## Response + +### Response Headers + +- Content-Type: application/json + +### Response Example + +```json +{ + "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": 35 + } +} +``` + +### Response Status + +| Status | Description | Schema | +| ------ | -------------- | -------------------------------------------------------- | +| 200 | Success | [public_agents_response](#schemapublic_agents_response) | +| 500 | Internal error | None | + +## Schemas + +### public_agents_response + + + +| Name | Type | Required | Description | +| -------------- | -------- | -------- | -------------------------------------------------------------------- | +| agents | object[] | true | Agent list, ordered by last updated time descending | +| ∟ uid | string | true | Agent UID, used as the path parameter of [Start Conversation](/docs/ai/chat/conversation) | +| ∟ name | string | true | Agent name, localized by the `Accept-Language` header | +| ∟ description | string | false | Agent description, localized by the `Accept-Language` header | +| ∟ mode | string | true | Agent mode, e.g. `chat` | +| ∟ icon | string | false | Icon URL | +| ∟ is_published | boolean | true | Always `true` for this endpoint | +| ∟ published_at | int64 | false | Publish time, Unix timestamp in seconds | +| ∟ created_at | int64 | false | Creation time, Unix timestamp in seconds | +| ∟ updated_at | int64 | false | Last updated time, Unix timestamp in seconds | +| total | int32 | true | Total number of public Agents matching the query | diff --git a/docs/zh-CN/docs/ai/agents.md b/docs/zh-CN/docs/ai/agents.md new file mode 100644 index 00000000..4688d7aa --- /dev/null +++ b/docs/zh-CN/docs/ai/agents.md @@ -0,0 +1,104 @@ +--- +slug: agents +title: 公开 Agent +sidebar_position: 0.5 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +列出平台上所有公开可用的 Agent——与探索页展示的是同一份目录。返回的 `uid` 即[发起对话](/zh-CN/docs/ai/chat/conversation)接口路径中使用的 Agent 标识。 + +与 [Workspace 下的 Agent](/zh-CN/docs/ai/workspace/agents) 不同，本接口不限定 Workspace：返回所有已发布且公开分享的 Agent。 + +## Request + + + + + + +
HTTP MethodGET
HTTP URL/v1/ai/agents
+ +### Query Parameters + +| Name | Type | Required | Description | +| ----- | ------ | -------- | ------------------------------ | +| page | int32 | NO | 页码，从 1 开始，默认 1 | +| limit | int32 | NO | 每页条数，默认 20，最大 50 | +| name | string | NO | 按 Agent 名称模糊搜索 | + +### Request Example + + + + +```bash +curl "https://openapi.longbridge.com/v1/ai/agents?page=1&limit=20" \ + -H "Authorization: Bearer " \ + -H "Accept: application/json" +``` + + + + +## Response + +### Response Headers + +- Content-Type: application/json + +### Response Example + +```json +{ + "code": 0, + "message": "success", + "data": { + "agents": [ + { + "uid": "ag_7d3f9b2c", + "name": "美股分析师", + "description": "结合行情与基本面数据回答美股问题", + "mode": "chat", + "icon": "https://cdn.longbridge.com/icons/agent.png", + "is_published": true, + "published_at": 1742000000, + "created_at": 1741000000, + "updated_at": 1742001000 + } + ], + "total": 35 + } +} +``` + +### Response Status + +| Status | Description | Schema | +| ------ | ----------- | -------------------------------------------------------- | +| 200 | 返回成功 | [public_agents_response](#schemapublic_agents_response) | +| 500 | 内部错误 | None | + +## Schemas + +### public_agents_response + + + +| Name | Type | Required | Description | +| -------------- | -------- | -------- | -------------------------------------------------------------- | +| agents | object[] | true | Agent 列表，按最后更新时间倒序 | +| ∟ uid | string | true | Agent UID，用作[发起对话](/zh-CN/docs/ai/chat/conversation)的路径参数 | +| ∟ name | string | true | Agent 名称，按 `Accept-Language` 请求头本地化 | +| ∟ description | string | false | Agent 描述，按 `Accept-Language` 请求头本地化 | +| ∟ mode | string | true | Agent 模式，如 `chat` | +| ∟ icon | string | false | 图标 URL | +| ∟ is_published | boolean | true | 本接口下恒为 `true` | +| ∟ published_at | int64 | false | 发布时间，Unix 秒级时间戳 | +| ∟ created_at | int64 | false | 创建时间，Unix 秒级时间戳 | +| ∟ updated_at | int64 | false | 最后更新时间，Unix 秒级时间戳 | +| total | int32 | true | 符合条件的公开 Agent 总数 | diff --git a/docs/zh-HK/docs/ai/agents.md b/docs/zh-HK/docs/ai/agents.md new file mode 100644 index 00000000..54ab25ea --- /dev/null +++ b/docs/zh-HK/docs/ai/agents.md @@ -0,0 +1,104 @@ +--- +slug: agents +title: 公開 Agent +sidebar_position: 0.5 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +列出平台上所有公開可用的 Agent——與探索頁展示的是同一份目錄。返回的 `uid` 即[發起對話](/zh-HK/docs/ai/chat/conversation)接口路徑中使用的 Agent 標識。 + +與 [Workspace 下的 Agent](/zh-HK/docs/ai/workspace/agents) 不同，本接口不限定 Workspace：返回所有已發佈且公開分享的 Agent。 + +## Request + + + + + + +
HTTP MethodGET
HTTP URL/v1/ai/agents
+ +### Query Parameters + +| Name | Type | Required | Description | +| ----- | ------ | -------- | ------------------------------ | +| page | int32 | NO | 頁碼，從 1 開始，默認 1 | +| limit | int32 | NO | 每頁條數，默認 20，最大 50 | +| name | string | NO | 按 Agent 名稱模糊搜索 | + +### Request Example + + + + +```bash +curl "https://openapi.longbridge.com/v1/ai/agents?page=1&limit=20" \ + -H "Authorization: Bearer " \ + -H "Accept: application/json" +``` + + + + +## Response + +### Response Headers + +- Content-Type: application/json + +### Response Example + +```json +{ + "code": 0, + "message": "success", + "data": { + "agents": [ + { + "uid": "ag_7d3f9b2c", + "name": "美股分析師", + "description": "結合行情與基本面數據回答美股問題", + "mode": "chat", + "icon": "https://cdn.longbridge.com/icons/agent.png", + "is_published": true, + "published_at": 1742000000, + "created_at": 1741000000, + "updated_at": 1742001000 + } + ], + "total": 35 + } +} +``` + +### Response Status + +| Status | Description | Schema | +| ------ | ----------- | -------------------------------------------------------- | +| 200 | 返回成功 | [public_agents_response](#schemapublic_agents_response) | +| 500 | 內部錯誤 | None | + +## Schemas + +### public_agents_response + + + +| Name | Type | Required | Description | +| -------------- | -------- | -------- | -------------------------------------------------------------- | +| agents | object[] | true | Agent 列表，按最後更新時間倒序 | +| ∟ uid | string | true | Agent UID，用作[發起對話](/zh-HK/docs/ai/chat/conversation)的路徑參數 | +| ∟ name | string | true | Agent 名稱，按 `Accept-Language` 請求頭本地化 | +| ∟ description | string | false | Agent 描述，按 `Accept-Language` 請求頭本地化 | +| ∟ mode | string | true | Agent 模式，如 `chat` | +| ∟ icon | string | false | 圖標 URL | +| ∟ is_published | boolean | true | 本接口下恆為 `true` | +| ∟ published_at | int64 | false | 發佈時間，Unix 秒級時間戳 | +| ∟ created_at | int64 | false | 創建時間，Unix 秒級時間戳 | +| ∟ updated_at | int64 | false | 最後更新時間，Unix 秒級時間戳 | +| total | int32 | true | 符合條件的公開 Agent 總數 |