onboarding

Documentation

Index

• func ArchiveBundle(bundle *Bundle) ([]byte, error)
• func BundleArchiveName(resp *BundleResponse) string
• func PreviewAgentID(agentName string) string
• func SuggestedAgentID(agentName string) string
• type APIKeyMode
• type Bundle
  • func BuildBundle(req BundleRequest) (*Bundle, error)
• type BundleAPIKey
• type BundleAgent
• type BundleArtifact
• type BundleDefault
• type BundleIntegration
• type BundleIntegrationRevision
• type BundleRequest
• type BundleResponse
• type BundleTenant
• type IntegrationInput
• type RegenerateInput
• type Runtime
• type SelectedTool
• type VerificationLink
• type WrittenArtifact
  • func WriteArtifacts(bundle *Bundle, outputDir string) ([]WrittenArtifact, error)

Functions

func ArchiveBundle

func ArchiveBundle(bundle *Bundle) ([]byte, error)

func BundleArchiveName

func BundleArchiveName(resp *BundleResponse) string

func PreviewAgentID

func PreviewAgentID(agentName string) string

func SuggestedAgentID

func SuggestedAgentID(agentName string) string

Types

type APIKeyMode

type APIKeyMode string

const (
	APIKeyModeRawProvided    APIKeyMode = "raw_provided"
	APIKeyModePreview        APIKeyMode = "preview_placeholder"
	APIKeyModeExistingKeyRef APIKeyMode = "existing_key_reference"
)

type Bundle

type Bundle struct {
	Title                 string             `json:"title"`
	Summary               string             `json:"summary"`
	Runtime               string             `json:"runtime"`
	RuntimeLabel          string             `json:"runtime_label"`
	StarterFileName       string             `json:"starter_file_name"`
	Environment           map[string]string  `json:"environment"`
	EnvironmentScript     string             `json:"environment_script"`
	EnvironmentFile       string             `json:"environment_file"`
	StarterSnippet        string             `json:"starter_snippet"`
	ReadmeSnippet         string             `json:"readme_snippet"`
	SampleCall            string             `json:"sample_call"`
	Artifacts             []BundleArtifact   `json:"artifacts"`
	VerificationChecklist []string           `json:"verification_checklist"`
	VerificationLinks     []VerificationLink `json:"verification_links"`
	AppliedDefaults       []BundleDefault    `json:"applied_defaults,omitempty"`
	Notes                 []string           `json:"notes"`
}

func BuildBundle

func BuildBundle(req BundleRequest) (*Bundle, error)

type BundleAPIKey

type BundleAPIKey struct {
	ID        string  `json:"id"`
	Name      string  `json:"name"`
	KeyPrefix string  `json:"key_prefix"`
	RawKey    string  `json:"raw_key,omitempty"`
	ExpiresAt *string `json:"expires_at,omitempty"`
}

type BundleAgent

type BundleAgent struct {
	ID        string `json:"id"`
	Name      string `json:"name"`
	Status    string `json:"status"`
	CreatedAt string `json:"created_at"`
	Preview   bool   `json:"preview"`
}

type BundleArtifact

type BundleArtifact struct {
	ID         string `json:"id"`
	Label      string `json:"label"`
	FileName   string `json:"file_name"`
	PathHint   string `json:"path_hint"`
	Kind       string `json:"kind"`
	Purpose    string `json:"purpose"`
	Writable   bool   `json:"writable"`
	Executable bool   `json:"executable,omitempty"`
	Language   string `json:"language,omitempty"`
	Content    string `json:"content"`
}

type BundleDefault

type BundleDefault struct {
	Field  string `json:"field"`
	Value  string `json:"value"`
	Reason string `json:"reason,omitempty"`
}

type BundleIntegration

type BundleIntegration struct {
	ID               string         `json:"id"`
	TenantID         string         `json:"tenant_id"`
	AgentID          string         `json:"agent_id"`
	Runtime          string         `json:"runtime"`
	EnvironmentLabel string         `json:"environment_label,omitempty"`
	OwnerName        string         `json:"owner_name,omitempty"`
	Description      string         `json:"description,omitempty"`
	ApprovalPosture  string         `json:"approval_posture,omitempty"`
	Tools            []SelectedTool `json:"tools,omitempty"`
	CreatedAt        string         `json:"created_at"`
	UpdatedAt        string         `json:"updated_at"`
}

type BundleIntegrationRevision

type BundleIntegrationRevision struct {
	ID               string         `json:"id"`
	IntegrationID    string         `json:"integration_id"`
	TenantID         string         `json:"tenant_id"`
	AgentID          string         `json:"agent_id"`
	Mode             string         `json:"mode"`
	Runtime          string         `json:"runtime"`
	EnvironmentLabel string         `json:"environment_label,omitempty"`
	OwnerName        string         `json:"owner_name,omitempty"`
	Description      string         `json:"description,omitempty"`
	ApprovalPosture  string         `json:"approval_posture,omitempty"`
	Tools            []SelectedTool `json:"tools,omitempty"`
	CreatedAt        string         `json:"created_at"`
}

type BundleRequest

type BundleRequest struct {
	BaseURL          string
	TenantID         string
	TenantName       string
	AgentID          string
	AgentName        string
	APIKey           string
	APIKeyMode       APIKeyMode
	APIKeyPrefix     string
	Runtime          Runtime
	ApprovalPosture  string
	EnvironmentLabel string
	OwnerName        string
	Description      string
	Tools            []SelectedTool
}

type BundleResponse

type BundleResponse struct {
	Mode        string             `json:"mode"`
	Tenant      BundleTenant       `json:"tenant"`
	Agent       BundleAgent        `json:"agent"`
	Integration *BundleIntegration `json:"integration,omitempty"`
	APIKey      *BundleAPIKey      `json:"api_key,omitempty"`
	Bundle      *Bundle            `json:"bundle"`
}

type BundleTenant

type BundleTenant struct {
	ID      string `json:"id"`
	Name    string `json:"name"`
	Created bool   `json:"created"`
}

type IntegrationInput

type IntegrationInput struct {
	Runtime          string         `json:"runtime"`
	TenantID         string         `json:"tenant_id,omitempty"`
	NewTenantName    string         `json:"new_tenant_name,omitempty"`
	AgentName        string         `json:"agent_name"`
	EnvironmentLabel string         `json:"environment_label,omitempty"`
	OwnerName        string         `json:"owner_name,omitempty"`
	Description      string         `json:"description,omitempty"`
	ApprovalPosture  string         `json:"approval_posture,omitempty"`
	Tools            []SelectedTool `json:"tools"`
}

type RegenerateInput

type RegenerateInput struct {
	IntegrationInput
	AgentID string `json:"agent_id"`
}

type Runtime

type Runtime string

const (
	RuntimePython      Runtime = "python"
	RuntimeTypeScript  Runtime = "typescript"
	RuntimeLangChain   Runtime = "langchain"
	RuntimeOpenAILocal Runtime = "openai_local"
)

type SelectedTool

type SelectedTool struct {
	Tool   string `json:"tool"`
	Action string `json:"action"`
}

type VerificationLink

type VerificationLink struct {
	Label       string `json:"label"`
	Path        string `json:"path"`
	Description string `json:"description,omitempty"`
}

type WrittenArtifact

type WrittenArtifact struct {
	ArtifactID string `json:"artifact_id"`
	Path       string `json:"path"`
}

func WriteArtifacts

func WriteArtifacts(bundle *Bundle, outputDir string) ([]WrittenArtifact, error)