@archastro/sdk
    Preparing search index...

    Interface ContextDocument

    A context document stored within a context source. Carries metadata and size information only; retrieve the full text content via the /content endpoint.

    interface ContextDocument {
        agent?: string;
        created_at?: string;
        file?: string;
        id: string;
        metadata?: Record<string, unknown>;
        source?: string;
        team?: string;
        title?: string;
        total_lines?: number;
        total_size?: number;
        updated_at?: string;
        user?: string;
    }
    Index

    Properties

    agent? created_at? file? id metadata? source? team? title? total_lines? total_size? updated_at? user?

    Properties

    agent?: string

    ID of the agent that owns this document (agi_...). null if owned by a user or team.

    created_at?: string

    When the document was created (ISO 8601).

    file?: string

    ID of the backing storage file (fil_...) when the document is file-backed. null for inline documents.

    id: string

    Context document ID (cdo_...).

    metadata?: Record<string, unknown>

    Arbitrary key-value metadata attached to the document. Shape varies by source type.

    source?: string

    ID of the context source this document belongs to (cso_...).

    team?: string

    ID of the team that owns this document (tem_...). null if owned by a user or agent.

    title?: string

    Human-readable display title of the document. null if no title has been set.

    total_lines?: number

    Total number of lines in the document's text content. 0 if the document has no content.

    total_size?: number

    Total byte size of the document's text content. 0 if the document has no content.

    updated_at?: string

    When the document was last modified (ISO 8601).

    user?: string

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

    Settings

    Member Visibility

    On This Page

    Properties