Install

Install a package from a GitHub repo

post/api/v1/install/github

Request

  • Base URL: https://api-docs.busabase.com
  • URL: https://api-docs.busabase.com/api/v1/install/github
  • Auth: none declared

Request body

repoUrlstring required

GitHub repo URL: https://github.com/<owner>/<repo>[/tree/<ref>[/<subdir>]]. Only GitHub hosts are accepted.

intoFolderstring

Slug of the folder to install into. Defaults to the package manifest's name.

renameboolean

Resolve slug collisions by suffixing (-2, -3, …) instead of refusing. Never overwrites anything.

autoMergeboolean

Whether the package's content change requests merge on the spot. Omitted defaults to merging immediately when the caller holds write access (installing is already a space owner/admin operation, so normally they do), otherwise leaving them for review; pass explicit false to force review even with write access. Either way, installing trusts the package author: a package can carry skills and AirApps, i.e. code this space's agents will execute.

Response

Created counts plus the number of change requests left for review. Structure (folders, Bases, fields, views) is created immediately — a pending Base has no id to attach a view or record to; content (records, docs, skills, AirApps) lands as change requests unless autoMerge is set.

targetFolderSlugstring required
targetFolderNodeIdstring required
pendingChangeRequestsinteger required
warningsstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.