The source object

Shape of a Data Source, uploaded files, scraped websites, or connector-backed knowledge bases.

A Source is a knowledge base an agent can read from, an uploaded file collection, a scraped website, a single webpage, or a connector-backed source (Google Drive, Notion, Zendesk Help Center).

Object shape

{
  "id": "source_64f1c0ef2ec711ef6dc1dcf",
  "type": "website",
  "name": "Macha Marketing Site",
  "connector_id": null,
  "connector_type": null,
  "sync_status": "ready",
  "last_sync_at": "2026-06-20T12:00:00.000Z",
  "document_count": 42,
  "is_active": true,
  "created_at": "2026-06-01T00:00:00.000Z",
  "updated_at": "2026-06-20T12:00:00.000Z"
}

Attributes

Field	Type	Notes
`id`	string	`source_<24 hex>`.
`type`	enum	`upload` \| `website` \| `webpage` \| `connector`. See the four-type table below.
`name`	string	Display name.
`connector_id`	string \| null	For `type=connector`, the connector this source is bound to.
`connector_type`	string \| null	e.g. `google`, `notion`, `confluence`, `zendesk`.
`sync_status`	string	`ready` \| `fetching` \| `syncing` \| `error`.
`last_sync_at`	ISO 8601 \| null	When the last sync completed.
`document_count`	integer \| null	How many documents are indexed.
`is_active`	boolean	Whether agents can query it.
`created_at`	ISO 8601	Always UTC.
`updated_at`	ISO 8601	Bumped on changes.

The four source types

Type	How it's created	API-creatable?
`upload`	Singleton, auto-provisioned per org. Holds files uploaded via the dashboard.	No (always exists). API POST returns 409.
`connector`	Auto-created when the connector is added (Google / Notion / Confluence / Zendesk HC).	No. API POST returns 422, use the connector flow.
`website`	Full-site crawl.	Yes via POST.
`webpage`	Single page.	Yes via POST.

Sync lifecycle

Indexing is asynchronous. When you POST a website source, the response returns sync_status: "fetching". Agents can't query it until sync_status: "ready". Poll the source by ID to check progress.

📘

No PATCH in v1

Sources are immutable after creation. To change a source, delete and recreate it.