@archastro/sdk
    Preparing search index...
    Index

    Constructors

    Methods

    Constructors

    Methods

    • List config kinds Returns all config kinds registered in the platform, sorted alphabetically by name. Each entry describes a type of configuration object (e.g., "Agent", "APITool") and indicates whether a JSON schema and a YAML sample are available for it. Any authenticated user may call this endpoint; no ownership scope is required. Pass one or more kind values to restrict the response to those specific kinds. Omit the parameter to receive the full list of non-private kinds.

      Parameters

      • Optionalparams: { kind?: string[] }

        Query parameters.

        • Optionalkind?: string[]

          One or more config kind names to include in the response (e.g., "Agent", "APITool"). Omit to return all non-private kinds.

      Returns Promise<
          {
              data: {
                  classification: string;
                  description?: string;
                  kind: string;
                  sample_available: boolean;
                  schema_available: boolean;
              }[];
          },
      >

      Successful response

    • Retrieve a config kind schema Returns the JSON schema and a YAML sample for a single config kind. Use this to understand the structure a config object of that kind must follow before creating or validating one. The json_schema field is null when the kind has no machine-readable schema defined. The sample_yaml field is null when no sample is available. Any authenticated user may call this endpoint; no ownership scope is required. Returns 404 if the kind name does not match a registered, non-private config kind.

      Parameters

      • kind: string

        Name of the config kind to retrieve (e.g., "Agent", "APITool"). Must match a registered, non-private kind exactly.

      Returns Promise<ConfigKindSchema>

      The JSON schema and YAML sample for the requested config kind.