@archastro/sdk
    Preparing search index...

    Interface KnowledgeSource

    A knowledge source that ingests content into the knowledge base. Sources connect to external systems (e.g. Gmail, GitHub) and continuously or on-demand index items for search.

    interface KnowledgeSource {
        agent?: string;
        context_installation?: string;
        created_at?: string;
        id: string;
        metadata?: Record<string, unknown>;
        org?: string;
        parent_source?: string;
        payload?: Record<string, unknown>;
        sandbox?: string;
        state: string;
        team?: string;
        thread?: string;
        type: string;
        updated_at?: string;
        user?: string;
    }
    Index

    Properties

    agent? context_installation? created_at? id metadata? org? parent_source? payload? sandbox? state team? thread? type updated_at? user?

    Properties

    agent?: string

    ID of the agent that owns this source (agt_...). null if owned by a human user or team.

    context_installation?: string

    ID of the context installation that provisioned this source (cin_...). null when the source was created directly rather than through an installation.

    created_at?: string

    When this knowledge source was created (ISO 8601).

    id: string

    Knowledge source ID (cso_...).

    metadata?: Record<string, unknown>

    Arbitrary key-value metadata attached to this source. Useful for storing caller-defined labels or references.

    org?: string

    ID of the organization this source belongs to (org_...). null if not scoped to an org.

    parent_source?: string

    ID of the parent knowledge source (cso_...) when this source was derived from another. null for top-level sources.

    payload?: Record<string, unknown>

    Type-specific configuration object. The keys depend on the source type; see the create endpoint for the expected shape per type.

    sandbox?: string

    ID of the developer sandbox this source is scoped to (sbx_...). null outside sandbox contexts.

    state: string

    Current lifecycle state of the source. One of "active" (ingestion running normally) or "paused" (ingestion suspended).

    team?: string

    ID of the team that owns this source (tea_...). null if owned by a user, agent, or org.

    thread?: string

    ID of the chat thread this source is associated with (thr_...). null when not thread-scoped.

    type: string

    Source type identifier (e.g. "gmail", "github_activity"). Determines the shape of payload and the ingestion behavior.

    updated_at?: string

    When this knowledge source was last modified (ISO 8601).

    user?: string

    ID of the user that owns this source (usr_...). null if owned by a team, agent, or org.

    Settings

    Member Visibility

    On This Page

    Properties