> ## Documentation Index > Fetch the complete documentation index at: https://docs.counso.ai/llms.txt > Use this file to discover all available pages before exploring further. # 列出智能体配置 列出指定工作区中的智能体配置。 ```http theme={"system"} GET /api/v1/w/{wId}/assistant/agent_configurations ``` 服务地址：`https://app.counso.ai` ## 认证 在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。 ## 请求参数 | 参数 | 位置 | 类型 | 必填 | 说明 | | ------------- | -- | ------ | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `wId` | 路径 | string | 是 | 工作区 ID | | `view` | 查询 | string | 否 | 获取智能体时使用的视图：all：获取所有非私有智能体（未认证时的默认值）；list：获取当前用户可访问的所有活跃智能体（已认证时的默认值）；published：获取已发布范围内的智能体；global：获取全局智能体；favorites：获取用户标记为收藏的所有智能体（仅已认证用户可用）；all\_unrestricted：获取工作区内所有活跃智能体，包括调用者不可访问配置的未发布智能体，以及要求访问调用者无权访问的 Space 的智能体。需要管理员 key。 可选值：`all`, `all_unrestricted`, `list`, `workspace`, `published`, `global`, `favorites` | | `withAuthors` | 查询 | string | 否 | 设为 true 时，为每个智能体包含近期作者信息 可选值：`true`, `false` | ## 响应 | HTTP 状态 | 说明 | | ------- | ------------------------------------ | | 200 | 工作区中的智能体配置 | | 400 | 请求错误：参数无效或缺失。 | | 401 | 未授权：身份验证令牌无效或缺失，或未认证用户正在尝试访问受限视图。 | | 403 | 禁止访问：all\_unrestricted 视图需要工作区管理员权限。 | | 404 | 未找到工作区。 | | 500 | 内部服务器错误。 | ## 接口规范 可下载完整的[OpenAPI / Postman](/zh-cn/docs/developer-platform/counso-api-documentation/openapi-and-postman) 文件。 ```json theme={"system"} { "openapi": "3.0.0", "info": { "title": "Counso API", "version": "1.0.2", "description": "API reference for Counso workspaces, Agents, conversations and data sources.", "license": { "name": "MIT", "url": "https://opensource.org/licenses/MIT" } }, "servers": [ { "url": "https://app.counso.ai", "description": "Counso" } ], "paths": { "/api/v1/w/{wId}/assistant/agent_configurations": { "get": { "summary": "List agents", "description": "Returns the set of agent configurations belonging to workspace {wId}.", "tags": [ "Agents" ], "parameters": [ { "in": "path", "name": "wId", "required": true, "description": "ID of the workspace", "schema": { "type": "string" } }, { "in": "query", "name": "view", "required": false, "description": "The view to use when retrieving agents:\n- all: Retrieves all non-private agents (default if not authenticated)\n- list: Retrieves all active agents accessible to the user (default if authenticated)\n- published: Retrieves all agents with published scope\n- global: Retrieves all global agents\n- favorites: Retrieves all agents marked as favorites by the user (only available to authenticated users)\n- all_unrestricted: Retrieves every active agent of the workspace, including unpublished agents the caller does not edit and agents requesting spaces the caller cannot access. Requires an admin key.\n", "schema": { "type": "string", "enum": [ "all", "all_unrestricted", "list", "workspace", "published", "global", "favorites" ] } }, { "in": "query", "name": "withAuthors", "required": false, "description": "When set to 'true', includes recent authors information for each agent", "schema": { "type": "string", "enum": [ "true", "false" ] } } ], "security": [ { "WorkspaceApiKey": [] }, { "UserAccessToken": [] } ], "responses": { "200": { "description": "Agent configurations for the workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "agentConfigurations": { "type": "array", "items": { "$ref": "#/components/schemas/AgentConfiguration" }, "description": "Array of agent configurations, optionally including lastAuthors if withAuthors=true" } } } } } }, "400": { "description": "Bad Request. Missing or invalid parameters." }, "401": { "description": "Unauthorized. Invalid or missing authentication token, or attempting to access restricted views without authentication." }, "403": { "description": "Forbidden. The all_unrestricted view requires a workspace admin." }, "404": { "description": "Workspace not found." }, "500": { "description": "Internal Server Error." } }, "x-counso-auth": "workspace" } } }, "components": { "securitySchemes": { "WorkspaceApiKey": { "type": "http", "scheme": "bearer", "description": "A workspace API key issued by this Counso deployment. Permissions and resource access are checked for each operation." }, "UserAccessToken": { "type": "http", "scheme": "bearer", "description": "A user OAuth access token issued for this Counso deployment. A workspace API key is not a substitute for a user token." }, "BrowserSession": { "type": "apiKey", "in": "cookie", "name": "workos_session", "description": "The signed-in Counso browser session. External clients should use a user access token." } }, "schemas": { "AgentConfiguration": { "type": "object", "properties": { "id": { "type": "integer", "example": 12345 }, "sId": { "type": "string", "description": "Unique string identifier for the agent configuration", "example": "7f3a9c2b1e" }, "version": { "type": "integer", "example": 2 }, "versionCreatedAt": { "type": "string", "nullable": true, "description": "Timestamp of when the version was created", "example": "2023-06-15T14:30:00Z" }, "versionAuthorId": { "type": "string", "nullable": true, "description": "ID of the user who created this version", "example": "0ec9852c2f" }, "name": { "type": "string", "description": "Name of the agent configuration", "example": "Customer Support Agent" }, "description": { "type": "string", "description": "Description of the agent configuration", "example": "An AI agent designed to handle customer support inquiries" }, "instructions": { "type": "string", "nullable": true, "description": "Instructions for the agent", "example": "Always greet the customer politely and try to resolve their issue efficiently." }, "pictureUrl": { "type": "string", "description": "URL of the agent's picture", "example": "https://example.com/agent-images/support-agent.png" }, "status": { "type": "string", "description": "Current status of the agent configuration", "example": "active" }, "scope": { "type": "string", "description": "Scope of the agent configuration", "example": "workspace" }, "userFavorite": { "type": "boolean", "description": "Status of the user favorite for this configuration", "example": true }, "model": { "type": "object", "properties": { "providerId": { "type": "string", "description": "ID of the model provider", "example": "openai" }, "modelId": { "type": "string", "description": "ID of the specific model", "example": "gpt-4" }, "temperature": { "type": "number", "example": 0.7 } } }, "actions": { "type": "array", "example": [] }, "skills": { "type": "array", "description": "Skills attached to the agent. Returned by the agent GET endpoints (list and single-agent) whatever the requested variant. Empty both for an agent with no skill and for an agent whose details were redacted for the caller (canRead false).", "items": { "$ref": "#/components/schemas/AgentSkill" } }, "tags": { "type": "array", "description": "Tags attached to the agent", "items": { "type": "object", "properties": { "sId": { "type": "string", "example": "3f9d1c7a5b" }, "name": { "type": "string", "example": "Support" }, "kind": { "type": "string", "enum": [ "standard", "protected" ] } } } }, "requestedSpaceIds": { "type": "array", "description": "Identifiers of the spaces the agent needs access to", "items": { "type": "string" }, "example": [ "vlt_a1b2c3d4e5" ] }, "maxStepsPerRun": { "type": "integer", "example": 10 }, "templateId": { "type": "string", "nullable": true, "description": "ID of the template used for this configuration", "example": "b4e2f1a9c7" } } }, "AgentSkill": { "type": "object", "description": "A skill attached to an agent configuration.", "properties": { "sId": { "type": "string", "description": "Unique string identifier for the skill", "example": "skill_abc123" }, "name": { "type": "string", "description": "Name of the skill", "example": "Customer Support" } } } } } } ```