@archastro/sdk
    Preparing search index...

    Interface Thread

    A chat thread, representing a conversation channel that can be owned by a user, team, or agent and may contain messages, participants, and AI agent activity.

    interface Thread {
        agent_user?: string;
        created_at?: string;
        creator?: User;
        description?: string;
        id: string;
        is_channel?: boolean;
        is_default?: boolean;
        is_transient?: boolean;
        is_unlisted?: boolean;
        key?: string;
        last_activity?: string;
        metadata?: Record<string, unknown>;
        muted?: boolean;
        org?: string;
        parent_message?: Message;
        participant?: string[];
        participants?: User[];
        participating_actor?: string[];
        participating_agents?: Agent[];
        role?: string;
        sandbox?: string;
        settings?: ThreadSettings;
        slug?: string;
        sub_threads?: Record<string, unknown>[];
        team?: string;
        title?: string;
        ttl?: number;
        unread_count?: number;
        updated_at?: string;
        user?: string;
    }
    Index

    Properties

    agent_user? created_at? creator? description? id is_channel? is_default? is_transient? is_unlisted? key? last_activity? metadata? muted? org? parent_message? participant? participants? participating_actor? participating_agents? role? sandbox? settings? slug? sub_threads? team? title? ttl? unread_count? updated_at? user?

    Properties

    agent_user?: string

    ID of the agent that owns this thread (agt_...). null for user-owned or team-owned threads.

    created_at?: string

    When the thread was created (ISO 8601).

    creator?: User

    Expanded user object for the user who created this thread. Populated only when the association is loaded.

    description?: string

    Optional description or purpose statement for the thread. null if not set.

    id: string

    Thread ID (thr_...).

    is_channel?: boolean

    Whether this thread operates as a channel — a multi-member broadcast-style conversation.

    is_default?: boolean

    Whether this is the default thread for its owner. Each user or team has at most one default thread.

    is_transient?: boolean

    Whether this thread is ephemeral and may be deleted automatically after a period of inactivity or when its TTL expires.

    is_unlisted?: boolean

    Whether this thread is hidden from public discovery. Unlisted threads are accessible only to direct participants.

    key?: string

    Application-defined stable key that uniquely identifies the thread within its scope. Useful for idempotent creation. null if not set.

    last_activity?: string

    When the last message or activity occurred in this thread. Present only when activity enrichment is requested.

    metadata?: Record<string, unknown>

    Arbitrary key-value metadata attached to the thread. Shape is application-defined; null if no metadata has been set.

    muted?: boolean

    Whether the authenticated user has muted notifications for this thread. true suppresses all notification delivery.

    org?: string

    ID of the organization this thread belongs to (org_...). null for threads outside an org context.

    parent_message?: Message

    The message that spawned this thread as a sub-thread. null for top-level threads.

    participant?: string[]

    Array of participant user IDs (usr_...) who are members of this thread.

    participants?: User[]

    Expanded participant user objects for each member of this thread. Populated only when the association is loaded.

    participating_actor?: string[]

    Composite actor identifiers for all participants currently active in this thread. Present only when actor enrichment is requested.

    participating_agents?: Agent[]

    Expanded agent objects for all agents participating in this thread. Present only when agent enrichment is requested.

    role?: string

    The authenticated user's membership role in this thread, e.g. "owner", "member", or "viewer". null if the user is not a member.

    sandbox?: string

    ID of the developer sandbox this thread is scoped to (sbx_...). null for production threads.

    settings?: ThreadSettings

    Per-thread configuration settings controlling AI agent behavior for this thread.

    slug?: string

    URL-safe slug for the thread, used in human-readable permalinks. null if not assigned.

    sub_threads?: Record<string, unknown>[]

    Threads that are nested under this thread as replies to a parent message. Present only when sub-thread enrichment is requested.

    team?: string

    ID of the team that owns this thread (team_...). null for user-owned or agent-owned threads.

    title?: string

    Human-readable name of the thread. null if no title has been set.

    ttl?: number

    Time-to-live in seconds after which the thread may be automatically cleaned up. null if the thread does not expire.

    unread_count?: number

    Number of messages in this thread that the authenticated user has not yet read. Present only when read-state enrichment is requested.

    updated_at?: string

    When the thread was last modified (ISO 8601).

    user?: string

    ID of the user who owns this thread (usr_...). null for team-owned or agent-owned threads.

    Settings

    Member Visibility

    On This Page

    Properties