@archastro/sdk
    Preparing search index...

    Interface SolutionSummary

    A catalog entry for an imported Solution, including its display metadata, bundled templates, owner scopes, and any available upgrade information.

    interface SolutionSummary {
        category_keys?: string[];
        created_at?: string;
        description?: string | null;
        events?: Record<string, unknown>;
        id: string;
        image_url?: string | null;
        installed_config_ids: string[];
        kind: string;
        latest_solution?: string | null;
        latest_version?: string | null;
        lookup_key?: string | null;
        metadata?: Record<string, unknown>;
        name?: string | null;
        org?: string | null;
        org_logo?: ImageSource | null;
        org_name?: string | null;
        org_slug?: string | null;
        owners: string[];
        readme_url?: string | null;
        screenshot_urls?: string[];
        solution_id?: string | null;
        solution_version?: string | null;
        tag_keys?: string[];
        template_kind?: string | null;
        templates: SolutionTemplateSummary[];
        updated_at?: string;
        upgrade_available: boolean;
        virtual_path?: string | null;
    }
    Index

    Properties

    category_keys? created_at? description? events? id image_url? installed_config_ids kind latest_solution? latest_version? lookup_key? metadata? name? org? org_logo? org_name? org_slug? owners readme_url? screenshot_urls? solution_id? solution_version? tag_keys? template_kind? templates updated_at? upgrade_available virtual_path?

    Properties

    category_keys?: string[]

    Category tag keys declared in the Solution body, used to group Solutions in the catalog. An empty array when the body declares none.

    created_at?: string

    When the Solution config was first imported (ISO 8601).

    description?: string | null

    Short tagline or summary declared in the Solution body, used as the card subhead in catalog UIs. null when the Solution body does not set one.

    events?: Record<string, unknown>

    Custom analytics events declared in the Solution body's events: manifest — a map of event key (snake_case) to its definition (label, optional description, optional typed fields). Dashboards use the label as the event's display name. Present as an empty object when the body declares none.

    id: string

    Solution config ID (cfg_...).

    image_url?: string | null

    Absolute URL of the Solution's cover image — the bundled asset the body's image: field names. A stable, non-expiring capability URL (like org_logo.url), safe to hold in caches and OpenGraph tags; it 404s if the Solution stops declaring a cover. null when the Solution has no cover image, and always null for org-scoped rows — the permanent URL is minted for system-scope (catalog) Solutions only.

    installed_config_ids: string[]

    Config IDs (cfg_...) of this Solution's installations in the viewer's organization. The array is empty when the Solution is visible only from the system catalog.

    kind: string

    Resource type. Always "Solution".

    latest_solution?: string | null

    When upgrade_available is true, the system-scope Solution config ID (cfg_...) that should be used as the upgrade source. null otherwise.

    latest_version?: string | null

    When upgrade_available is true, the higher system-scope solution_version available to upgrade to. null otherwise.

    lookup_key?: string | null

    The lookup key stored on the Solution config, if one was assigned during import. null when no lookup key was set.

    metadata?: Record<string, unknown>

    Arbitrary key-value metadata declared in the Solution body (e.g. category or display hints). Present as an empty object when the body declares none.

    name?: string | null

    Human-facing display name declared in the Solution body. null when the Solution body does not set one.

    org?: string | null

    Organization ID (org_...) that owns this Solution config, when the Solution is scoped to a specific org. null for system-scope (app-level) Solutions.

    org_logo?: ImageSource | null

    Canonical image-source object for the resolved org's logo, used as the principal category section glyph. The url is a stable, non-expiring capability URL (refresh_url is null — there is nothing to refresh). null when org_slug is null or the org has no logo.

    org_name?: string | null

    Display name of the resolved org. Pairs with org_slug as the principal catalog category's label. null when org_slug is null.

    org_slug?: string | null

    Resolved slug of the Solution body's org (the publishing organization), when set and it resolves to a real org visible to the viewer. When present this is the Solution's principal catalog category key — clients group the Solution under this org ahead of category_keys. null when the body has no org or it doesn't resolve.

    owners: string[]

    Owner scopes this Solution appears under. Members: "system" (app-level system scope) and/or "org" (viewer's org scope).

    readme_url?: string | null

    Relative path to the public README endpoint with a signed token already embedded. null when the Solution has no README. Token expires in 1 hour — refresh via GET /api/v1/solutions/:solution.

    screenshot_urls?: string[]

    Absolute URLs of the Solution's gallery screenshots — the bundled assets the body's screenshots: field names, in declared order. Each is a stable, non-expiring capability URL with the same cacheability contract as image_url (one shared token, a v cache key, and a file param selecting the screenshot); a URL 404s if the Solution stops declaring its screenshot. An empty array when the Solution declares none, and always empty for org-scoped rows — the permanent URLs are minted for system-scope (catalog) Solutions only.

    solution_id?: string | null

    Stable UUID declared in the Solution body, used to identify the same logical Solution across multiple installed copies and owner scopes. null when the body omits it.

    solution_version?: string | null

    Semver string declared in the Solution body (e.g. "1.2.0"). null when the body does not declare a version.

    tag_keys?: string[]

    Freeform tag keys declared in the Solution body. An empty array when the body declares none.

    template_kind?: string | null

    Wrapped template kind — "AgentTemplate", "AutomationTemplate", "AgentRoutineTemplate", "AgentToolTemplate", "AgentComputerTemplate", or "SolutionTemplateRef" for ref-mode bundles.

    templates: SolutionTemplateSummary[]

    Template configs bundled by this Solution, in declaration order — the first entry is the deployable template the Solution wraps; the rest are sibling templates the wrapped template references.

    updated_at?: string

    When the Solution config was last modified (ISO 8601).

    upgrade_available: boolean

    true when this Solution is installed at the viewer's org scope and the app-level system scope carries a higher solution_version. Always false for system-only rows.

    virtual_path?: string | null

    The stable virtual path assigned to this Solution config, used as the deduplication key when the same Solution appears under multiple owner scopes. null when unset.

    Settings

    Member Visibility

    On This Page

    Properties