List crawl seeds

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}}; fetch('https://{host}/v2/workspaces/slug:storage/webhooks/v1/knowledge_bases/{knowledgeBaseId}/web_sources', options) .then(res => res.json()) .then(res => console.log(res)) .catch(err => console.error(err));

import requests url = "https://{host}/v2/workspaces/slug:storage/webhooks/v1/knowledge_bases/{knowledgeBaseId}/web_sources" headers = {"Authorization": "Bearer <token>"} response = requests.get(url, headers=headers) print(response.text)

{ "object": "list", "data": [ { "id": "<string>", "object": "knowledge_base.web_source", "knowledge_base_id": "<string>", "url": "<string>", "created_at": 123, "crawler_options": {}, "last_crawl_at": 123, "next_crawl_at": 123, "metrics": { "pages_total": 1, "pages_indexed": 1, "pages_failed": 1, "pages_pending": 1, "pages_skipped": 1, "last_run_started_at": 123, "last_run_completed_at": 123 }, "updated_at": 123 } ], "total": 1, "page": 2, "limit": 50, "has_more": true, "summary": { "total_web_pages": 1, "unattributed_count": 1 } }

Authorizations

Authorization

string

header

required

User session JWT or instance API key (iak_*). Send as Authorization: Bearer <token>.

Path Parameters

knowledgeBaseId

string

required

Knowledge base id. Legacy physical prefix vs_ (the kb_ rename is deferred).

Maximum string length: 128

Pattern: ^vs_[A-Za-z0-9-]+$

Query Parameters

limit

integer

default:20

Page size. Server clamps to [1, 100] silently.

Required range: 1 <= x <= 100

page

integer

default:1

1-based page number.

Required range: x >= 1

Response

Paginated seeds, plus a knowledge-base-level summary (§F-5): the unattributed residual (web pages with no seed attribution) and the total web-page count.

Shared list-response envelope. Array is always data. Every element carries its own object discriminator.

object

enum<string>

required

Available options:

list

data

object[]

required

Hide child attributes

data.id

string

required

Maximum string length: 128

Pattern: ^seed_[A-Za-z0-9-]+$

data.object

enum<string>

required

Available options:

knowledge_base.web_source

data.knowledge_base_id

string

required

Pattern: ^vs_[A-Za-z0-9-]+$

data.url

string<uri>

required

Seed URL the crawler starts from.

data.created_at

integer

required

data.crawler_options

object | null

Provider-specific crawl configuration passed through to the crawler (e.g. include/exclude URL patterns, auth headers, render mode). Validated by the crawler, not by this API. Projects PER DOMAIN on the store-level crawler: sources on the same hostname share these options.

data.last_crawl_at

integer | null

Reserved. Currently always null - there is no per-seed crawl-run ledger yet.

data.next_crawl_at

integer | null

Reserved. Currently always null (no per-seed scheduled-run computation yet).

data.metrics

object

Per-seed page counts, DB-derived from documents attributed to this seed via parent_web_source_ids (multi-attribution, §F-5). Independent of crawler reachability - these are always available even when the crawler is unreachable.

Hide child attributes

data.metrics.pages_total

integer

Required range: x >= 0

data.metrics.pages_indexed

integer

Required range: x >= 0

data.metrics.pages_failed

integer

Required range: x >= 0

data.metrics.pages_pending

integer

Required range: x >= 0

data.metrics.pages_skipped

integer

Reserved. Currently always 0 (no per-seed "skipped" status).

Required range: x >= 0

data.metrics.last_run_status

enum<string> | null

Reserved. Currently always null (no per-seed run ledger).

Available options:

running,

completed,

failed,

partial,

null

data.metrics.last_run_started_at

integer | null

Reserved. Currently always null.

data.metrics.last_run_completed_at

integer | null

Reserved. Currently always null.

data.updated_at

integer

total

integer

required

Required range: x >= 0

page

integer

required

Required range: x >= 1

limit

integer

required

Required range: 1 <= x <= 100

has_more

boolean

required

summary

object

Hide child attributes

summary.total_web_pages

integer

Required range: x >= 0

summary.unattributed_count

integer

Web pages with empty/absent parent_web_source_ids (off-domain redirects, or pre-backfill rows).

Required range: x >= 0

Introduction

Platform API

Agent Creator API

LLM Gateway API

Governance API

Knowledges API

Authorizations

Path Parameters

Query Parameters

Response