@archastro/sdk
    Preparing search index...

    Interface SolutionTemplateSummary

    Identity and display metadata for a single template bundled by a Solution, used to represent each wrapped or sibling template at template granularity.

    interface SolutionTemplateSummary {
        description?: string | null;
        details?:
            | {
                automation_type?: string
                | null;
                invoke_contract?:
                    | {
                        input_schema?: Record<string, {} | null>
                        | null;
                        participants?:
                            | {
                                description?: string
                                | null;
                                name: string;
                                required: boolean;
                                type: string;
                            }[]
                            | null;
                        prefills: {
                            participants?: Record<string, {} | null>;
                            payload?: Record<string, {} | null>;
                        };
                    }
                    | null;
                type: "automation";
            }
            | null;
        display_name?: string
        | null;
        id?: string | null;
        kind: string;
        lookup_key?: string | null;
        name?: string | null;
        readme_url?: string | null;
        virtual_path?: string | null;
    }
    Index

    Properties

    description? details? display_name? id? kind lookup_key? name? readme_url? virtual_path?

    Properties

    description?: string | null

    Short prose blurb from the template body's description: field. null when the body doesn't set one. Used as the card subhead in the Library carousel.

    details?:
        | {
            automation_type?: string
            | null;
            invoke_contract?:
                | {
                    input_schema?: Record<string, {} | null>
                    | null;
                    participants?:
                        | {
                            description?: string
                            | null;
                            name: string;
                            required: boolean;
                            type: string;
                        }[]
                        | null;
                    prefills: {
                        participants?: Record<string, {} | null>;
                        payload?: Record<string, {} | null>;
                    };
                }
                | null;
            type: "automation";
        }
        | null

    Template-kind-specific details selected by the type discriminator. null when this template kind has no additional details.

    Type Declaration

    • {
          automation_type?: string | null;
          invoke_contract?:
              | {
                  input_schema?: Record<string, {} | null>
                  | null;
                  participants?:
                      | {
                          description?: string
                          | null;
                          name: string;
                          required: boolean;
                          type: string;
                      }[]
                      | null;
                  prefills: {
                      participants?: Record<string, {} | null>;
                      payload?: Record<string, {} | null>;
                  };
              }
              | null;
          type: "automation";
      }
      • Optionalautomation_type?: string | null

        Automation execution type (invoked, scheduled, or trigger). null when the template body does not declare one.

      • Optionalinvoke_contract?:
            | {
                input_schema?: Record<string, {} | null>
                | null;
                participants?:
                    | {
                        description?: string
                        | null;
                        name: string;
                        required: boolean;
                        type: string;
                    }[]
                    | null;
                prefills: {
                    participants?: Record<string, {} | null>;
                    payload?: Record<string, {} | null>;
                };
            }
            | null

        Schema-driven payload and participant inputs for an invoked automation. Used by installation clients to collect locked prefills before provisioning. null for non-invoked automation types.

      • type: "automation"

        Template-details discriminator. Always automation for this variant.

    • null
    display_name?: string | null

    Human-facing label from the template body's display_name: field. null when the body doesn't set one. Library carousels use this for the card title, falling back to a humanized name.

    id?: string | null

    Template config ID (cfg_...). null for inline-only templates.

    kind: string

    Template config kind, or SolutionTemplateRef / SolutionTemplatePath when unresolved.

    lookup_key?: string | null

    Lookup key stamped on the template config at import time. null when no lookup key was assigned.

    name?: string | null

    Canonical name from the template body. For AgentTemplate this doubles as the human-facing label; for AgentToolTemplate it's the LLM-facing tool function identifier (snake_case); for AgentRoutineTemplate it's the routine identifier (kebab-case). Clients rendering carousels should prefer display_name and fall back to humanizing name.

    readme_url?: string | null

    Relative path to the public README endpoint with a signed token already embedded, scoped to this template's bundled markdown asset. null when the Solution body's templates[].readme_path is unset for this entry. Token expires in 1 hour — refresh via GET /api/v1/solutions/:solution.

    virtual_path?: string | null

    Stable virtual path assigned to the template config. null when no virtual path was set.

    Settings

    Member Visibility

    On This Page

    Properties