Skip to main content
POST
Archive a source

Authorizations

Authorization
string
header
required

Your secret key (pep_sk_…) from Settings → API. Keys are org-scoped; treat them like passwords.

Path Parameters

id
integer
required

Response

The archived source.

object
string
required
Allowed value: "knowledge_source"
id
integer
required
kind
enum<string>
required
Available options:
text,
url,
file,
website
title
string
required
status
enum<string>
required

Aggregated from the source's entries: ready (everything ingested), updating (work in flight — poll), attention (usable with some failed entries), failed (nothing usable).

Available options:
ready,
updating,
attention,
failed
agents
string[]
required

Slugs of the agents this source is active for.

metadata
object
required
entries
object
required

Entry counts by status (one entry per page for websites).

archived
boolean
required
created_at
string<date-time>
required
external_id
string | null
url
string | null

The page (url) or site root (website).

failure_reason
string | null

Single-entry kinds: why processing failed, human-readable. Websites report per-entry reasons under /entries.

language
string | null
digest
string | null

What the agent understood from this source (generated after each refresh).

max_pages
integer | null

website kind only.

last_update_at
string<date-time> | null

When the last refresh run landed — the freshness stamp.

body
string

Full text. Present on retrieve/create/update for text/url/file; websites read per-page content via /entries.