---
title: "Retrieve the agent's website knowledge base"
method: GET
path: "/v1/agents/{id}/knowledge-bases/website"
---

# Retrieve the agent's website knowledge base

`GET /v1/agents/{id}/knowledge-bases/website`

## Request

- Base URL: `https://api.runbear.io`
- URL: `https://api.runbear.io/v1/agents/{id}/knowledge-bases/website`
- Auth: HTTP bearer

Returns the website-crawl knowledge base configuration and sync status for an agent. Returns 404 if the agent has no website knowledge base configured.

## Path parameters

- `id` string, uuid, required: The ID of the agent to retrieve

## Response `200`

Default Response

- WebsiteKnowledgeBase: Runbear-managed website crawl knowledge base for the agent
  - `configs` WebsiteKnowledgeBaseConfig[], required: Crawl configurations for the website knowledge base
    - `rootUrl` string, required: Root URL crawled for this knowledge base entry
    - `excludedUrls` string[]: URLs excluded from the crawl
    - `nodeSelections` KnowledgeBaseNodeSelection[], required: Specific pages/subtrees selected under the root URL
      - `id` string, required: Selection node ID. For Google Drive: the Drive/folder/file ID. For Website: the URL.
      - `ancestorIds` string[], required: Ancestor node IDs, root first
      - `excludedChildIds` string[], required: Node IDs explicitly excluded from sync
      - `disableSyncNewChildren` boolean: When true, newly discovered children of this node are not auto-synced
  - `syncStatus` KnowledgeBaseSyncStatus, required: Sync status snapshot for a knowledge base. lastHeartbeatAt and internal error metadata are omitted.
    - `state` 'IN_PROGRESS' | 'SUCCESS' | 'PARTIAL_SUCCESS' | 'FAILED' | 'SUSPENDED', required: Current sync state for this knowledge base
    - `lastSuccessAt` string, nullable, required: Timestamp of the last fully successful sync, or null if never completed
    - `lastDurationMs` integer, nullable, required: Duration of the last sync attempt in milliseconds
    - `error` object, nullable, required: Most recent sync error, if any
      - `type` string, required: Error category (server_error, authentication, authorization, disintegrated, …)
      - `message` string, required: Human-readable error message

## Other responses

- `404`: Default Response

---

[API](https://skmtc.dev/runbear/apis/runbear-api.md) - [All operations](https://skmtc.dev/runbear/apis/runbear-api/llms.txt) - [OpenAPI document](https://skmtc.dev/runbear/apis/runbear-api/revisions/c6a9c3066a5a?raw)