> ## Documentation Index > Fetch the complete documentation index at: https://docs.nimbleway.com/llms.txt > Use this file to discover all available pages before exploring further. # List Agents > List the active Web Search Agents in your account. Results are scoped to the workspace resolved from your token (or the optional `workspace_id` query parameter) and paginated with `offset`/`limit`. ## OpenAPI ````yaml /api-reference/openapi.json get /v2/agents openapi: 3.1.0 info: title: Nimble SDK version: 1.0.0 description: The AI-Native SDK for Real-Time Web Data at scale servers: - url: https://sdk.nimbleway.com security: [] paths: /v2/agents: get: tags: - Public API summary: List Agents description: >- List the active Web Search Agents in your account. Results are scoped to the workspace resolved from your token (or the optional `workspace_id` query parameter) and paginated with `offset`/`limit`. operationId: list_agents_public_v2_api_v2_public_web_search_agents_get parameters: - in: query name: workspace_id required: false schema: anyOf: - format: uuid type: string - type: 'null' title: Workspace Id description: >- Only return agents belonging to this workspace. Defaults to the workspace resolved from your token. - in: query name: offset required: false schema: default: 0 minimum: 0 title: Offset type: integer description: Number of items to skip before this page. - in: query name: limit required: false schema: default: 100 maximum: 200 minimum: 1 title: Limit type: integer description: Maximum number of items to return (1-200). responses: '200': content: application/json: schema: $ref: >- #/components/schemas/ListResponse_WebSearchAgentResponsePublicV2_ description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - BearerAuth: [] components: schemas: ListResponse_WebSearchAgentResponsePublicV2_: properties: items: description: Items returned in this page. items: $ref: '#/components/schemas/WebSearchAgentResponsePublicV2' title: Items type: array limit: description: Maximum number of items returned. title: Limit type: integer offset: description: Number of items skipped before this page. title: Offset type: integer total: description: Total number of items matching the query. title: Total type: integer required: - items - total - limit - offset title: ListResponse[WebSearchAgentResponsePublicV2] type: object HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' title: Detail type: array title: HTTPValidationError type: object WebSearchAgentResponsePublicV2: properties: agent_name: anyOf: - type: string - type: 'null' description: Stable agent name. title: Agent Name created_at: description: When the agent was created. format: date-time title: Created At type: string description: description: Agent description shown to users. title: Description type: string display_name: description: Human-friendly agent name shown to users. title: Display Name type: string example: Company News Tracker effort: $ref: '#/components/schemas/Effort' description: Default effort level for this agent's runs. example: high goals: description: Ordered goals for the agent to follow. items: $ref: '#/components/schemas/WebSearchAgentGoalResponsePublicV2' title: Goals type: array icon: description: Icon identifier used when presenting the agent. title: Icon type: string id: description: Unique web search agent identifier (wsa_). title: Id type: string example: wsa_2af5b0e2-58b8-4b60-a1a4-9e57e4d33f00 is_active: description: Whether the agent can be used to start new runs. title: Is Active type: boolean output_schema: anyOf: - additionalProperties: true type: object - type: 'null' description: >- JSON schema describing the structured output the agent should produce. title: Output Schema skill: description: Skill or operating context for the agent. title: Skill type: string sources: $ref: '#/components/schemas/AgentSourcesResponsePublicV2' description: Source guidance for the agent. suggested_questions: description: Suggested prompts users can run with this agent. items: $ref: >- #/components/schemas/WebSearchAgentSuggestedQuestionResponsePublicV2 title: Suggested Questions type: array updated_at: description: When the agent was last updated. format: date-time title: Updated At type: string use_case: $ref: '#/components/schemas/WebSearchAgentUseCase' description: Primary use case supported by the agent. example: research required: - id - display_name - description - icon - effort - skill - use_case - output_schema - is_active - created_at - updated_at - sources - goals - suggested_questions title: WebSearchAgentResponsePublicV2 type: object ValidationError: properties: ctx: title: Context type: object input: title: Input loc: items: anyOf: - type: string - type: integer title: Location type: array msg: title: Message type: string type: title: Error Type type: string required: - loc - msg - type title: ValidationError type: object Effort: description: Canonical effort tier names for the research graph. enum: - low - medium - high - x-high - max title: Effort type: string WebSearchAgentGoalResponsePublicV2: properties: goal: description: Goal text. title: Goal type: string id: description: Unique goal identifier (wsag_). title: Id type: string order: description: Zero-based goal position. title: Order type: integer required: - id - goal - order title: WebSearchAgentGoalResponsePublicV2 type: object AgentSourcesResponsePublicV2: additionalProperties: false properties: allow: description: Source groups the agent is allowed to use. items: $ref: '#/components/schemas/WebSearchAgentSourceResponsePublicV2' title: Allow type: array avoid: anyOf: - type: string - type: 'null' description: Free-text guidance describing sources or domains to avoid. title: Avoid block: description: Source groups the agent should not use. items: $ref: '#/components/schemas/WebSearchAgentSourceResponsePublicV2' title: Block type: array prioritize: anyOf: - type: string - type: 'null' description: Free-text guidance describing sources or domains to prioritize. title: Prioritize title: AgentSourcesResponsePublicV2 type: object WebSearchAgentSuggestedQuestionResponsePublicV2: properties: id: description: Unique suggested question identifier (wsasq_). title: Id type: string order: description: Zero-based suggested question position. title: Order type: integer question: description: Suggested prompt text. title: Question type: string required: - id - question - order title: WebSearchAgentSuggestedQuestionResponsePublicV2 type: object WebSearchAgentUseCase: enum: - research - enrichment - dataset_building title: WebSearchAgentUseCase type: string WebSearchAgentSourceResponsePublicV2: properties: domains: description: Domains included in this source group. items: type: string title: Domains type: array example: - linkedin.com - crunchbase.com id: description: Unique source group identifier (wsas_). title: Id type: string order: description: Zero-based source group position. title: Order type: integer title: description: Source group title. title: Title type: string example: Professional networks required: - id - title - domains - order title: WebSearchAgentSourceResponsePublicV2 type: object securitySchemes: BearerAuth: type: http scheme: bearer ````