Skip to main content
Siteleaf logo
  • Category: developer tools
  • Auth: API_KEY, BASIC
  • Composio-managed OAuth available? N/A
  • Tools: 35
  • Triggers: 0
  • Slug: SITELEAF
  • Version: 20261030_00

Tools

Slug: SITELEAF_CANCEL_JOBCancel an active Siteleaf job by job ID. This irreversibly requests that the job stop.

Input Parameters

string
required
Active Siteleaf job ID, such as one returned by publishing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_CREATE_COLLECTIONCreate a content collection in a Siteleaf site.

Input Parameters

string
Collection path; Siteleaf derives one from the title when omitted.
string
required
Collection title.
boolean
Whether Siteleaf should generate output pages for this collection.
string
required
Site that will contain the collection.
object
Collection custom metadata.
Collection permalink template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_CREATE_COLLECTION_FILEUpload one static file to a Siteleaf collection identified by its path. This action cannot create collection documents or content files with YAML front matter.

Input Parameters

object
required
One static file to upload. This endpoint is only for static files and cannot create collection documents or content files with YAML front matter.
string
required
Site containing the collection.
string
required
Path identifying the collection where the static file will be uploaded.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_CREATE_DOCUMENTCreate a document in a Siteleaf collection with content, taxonomy, metadata, and visibility.

Input Parameters

string
Document body content.
string
Document date in ISO 8601 format.
string
Document path relative to the collection.
array
Tags assigned to the document.
string
required
Document title.
string
required
Site containing the collection.
object
Document custom metadata.
Custom document permalink.
array
Categories assigned to the document.
string ("visible" | "hidden")
Initial document visibility; provider docs list visible|hidden for writes, draft is a read-only state.
string
required
Collection that will contain the document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_CREATE_PAGECreate a page in a Siteleaf site.

Input Parameters

string
Page body content.
string
Page date in ISO 8601 format.
string
Page path within the site.
string
required
Page title.
string
required
Site that will contain the page.
object
Page custom metadata.
Custom permalink.
string ("visible" | "hidden")
Initial page visibility.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_CREATE_ROLEGrant a Siteleaf user an admin, publisher, or writer role on a site.

Input Parameters

string ("admin" | "publisher" | "writer")
required
Role level to grant: admin, publisher, or writer.
string
required
Site on which access is granted.
string
required
Siteleaf user receiving access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_CREATE_SITECreate a Siteleaf site with its domain, timezone, metadata, and defaults.

Input Parameters

boolean
Create the site without Siteleaf starter content when true.
string
required
Human-readable site title.
string
required
Domain assigned to the site.
array
Jekyll default value definitions applied to scoped content.
object
Arbitrary site-level custom metadata.
string
Site timezone name; defaults to UTC.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_DELETE_COLLECTIONPermanently delete a Siteleaf collection by site ID and collection path. This cannot be undone.

Input Parameters

string
required
ID of the Siteleaf site containing the collection.
string
required
Path of the collection to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_DELETE_DOCUMENTPermanently delete a Siteleaf document by ID. This cannot be undone.

Input Parameters

string
required
ID of the document to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_DELETE_PAGEPermanently delete a Siteleaf page by ID. This cannot be undone.

Input Parameters

string
required
ID of the Siteleaf page to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_DELETE_ROLEDelete a Siteleaf role by ID, removing the user’s access to its site.

Input Parameters

string
required
ID of the Siteleaf role to delete, removing the user’s site access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_DELETE_SITEPermanently delete a Siteleaf site by ID. This cannot be undone.

Input Parameters

string
required
ID of the Siteleaf site to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_DELETE_SOURCEPermanently delete one raw source file from a Siteleaf site. Directories and _config.yml are protected and cannot be deleted.

Input Parameters

string
required
ID of the Siteleaf site containing the source file.
string
required
Relative source filename or nested file path to permanently delete. Directories and _config.yml cannot be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_GET_COLLECTIONGet a collection by site ID and collection path.

Input Parameters

string
required
Site containing the collection.
string
required
Existing collection path.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_GET_CURRENT_USERReturn the Siteleaf user authenticated by the connected API key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_GET_DOCUMENTGet a Siteleaf document by ID.

Input Parameters

string
required
Siteleaf document ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_GET_JOBGet the complete buffered status stream for a Siteleaf job, including all status events and the latest status details. The call waits until Siteleaf closes the event stream.

Input Parameters

string
required
Siteleaf job ID, such as one returned by publishing a site.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_GET_PAGEGet a Siteleaf page by ID.

Input Parameters

string
required
Siteleaf page ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_GET_ROLEGet a Siteleaf site-access role by ID.

Input Parameters

string
required
Siteleaf role ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_GET_SITEGet one Siteleaf site by ID, including its settings and current or most recent preview, publish, and synchronization job states.

Input Parameters

string
required
Siteleaf site ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_GET_SITE_TAXONOMYReturn the unique post tags and categories used by a Siteleaf site.

Input Parameters

string
required
Site whose post taxonomy should be read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_GET_SOURCEGet raw source-file metadata or list a source directory for a Siteleaf site.

Input Parameters

string
required
Site whose source tree should be read.
string
File or directory path; omit to list the source root.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_LIST_COLLECTION_FILESSearch and list static files in a Siteleaf collection with sorting and agent-controlled pagination.

Input Parameters

string
Sort as field-asc or field-desc, such as filename-asc or created_at-desc.
string
Search files by filename.
string
required
Site containing the collection.
integer
Number of files to request in this page; Siteleaf documents no maximum.
string
Opaque continuation cursor returned by a previous call; omit for the first page.
string
required
Collection path.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_LIST_COLLECTIONSList content collections in a Siteleaf site with agent-controlled pagination.

Input Parameters

string
required
Site whose collections should be listed.
integer
Number of collections to request in this page; Siteleaf documents no maximum.
string
Opaque continuation cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_LIST_DOCUMENTSSearch and list documents in a Siteleaf collection with visibility, extension, sorting, and pagination filters.

Input Parameters

string
Sort as field-asc or field-desc, such as title-asc or created_at-desc.
string
Search document titles and paths.
string
required
Site containing the collection.
integer
Number of documents to request in this page; Siteleaf documents no maximum.
string
Comma-separated filename extensions.
string ("visible" | "hidden" | "draft")
Filter documents by visibility.
string
Opaque continuation cursor returned by a previous call; omit for the first page.
string
required
Collection whose documents should be listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_LIST_PAGESSearch and list pages in a Siteleaf site with visibility, extension, sorting, and pagination filters.

Input Parameters

string
Sort as field-asc or field-desc, such as title-asc or created_at-desc.
string
Search page titles and paths.
string
required
Site whose pages should be listed.
integer
Number of pages to request in this page; Siteleaf documents no maximum.
string
Comma-separated filename extensions; Siteleaf supports markdown aliases.
string ("visible" | "hidden")
Filter pages by visibility.
string
Opaque continuation cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_LIST_SITESList sites accessible to the connected Siteleaf account, with optional sorting and agent-controlled pagination.

Input Parameters

string
Sort expression in field-asc or field-desc form.
integer
Number of sites to request in this page; Siteleaf documents no maximum.
string
Opaque continuation cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_LIST_SITE_USERSList users who have access to a Siteleaf site with agent-controlled pagination.

Input Parameters

string
required
Site whose users should be listed.
integer
Number of users to request in this page; Siteleaf documents no maximum.
string
Opaque continuation cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_PUBLISH_SITEStart an asynchronous compile-and-publish job for a Siteleaf site and return its job ID. This publishes externally visible site content and does not wait for job completion.

Input Parameters

string
required
ID of the Siteleaf site to publish.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_UPDATE_COLLECTIONUpdate at least one of a collection’s title, path, permalink, output behavior, or metadata.

Input Parameters

string
Replacement collection title.
boolean
Whether collection documents generate output.
string
required
Site containing the collection.
object
Replacement collection custom metadata object.
string
Replacement collection path.
Replacement permalink template.
string
required
Current collection path used to locate it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_UPDATE_DOCUMENTUpdate at least one of a document’s content, path, taxonomy, visibility, metadata, or date.

Input Parameters

string
Replacement document body content.
string
Replacement document date in ISO 8601 format.
string
Replacement document path.
array
Replacement tags assigned to the document.
string
Replacement document title.
object
Replacement document custom metadata object.
Replacement custom permalink.
array
Replacement categories assigned to the document.
string ("visible" | "hidden")
Replacement document visibility; provider docs list visible|hidden for writes, draft is a read-only state.
string
required
Document to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_UPDATE_PAGEUpdate at least one of a page’s content, path, visibility, metadata, or publication date.

Input Parameters

string
Replacement page body content.
string
Replacement page date in ISO 8601 format.
string
Replacement page path.
string
Replacement page title.
string
required
Page to update.
object
Replacement page custom metadata object.
Replacement custom permalink.
string ("visible" | "hidden")
Replacement page visibility.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_UPDATE_ROLEChange an existing Siteleaf role to admin, publisher, or writer.

Input Parameters

string ("admin" | "publisher" | "writer")
required
Replacement role level: admin, publisher, or writer.
string
required
Role to change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_UPDATE_SITEUpdate at least one of a site’s title, domain, timezone, metadata, or Jekyll content defaults. Hosting credentials and repository sync are intentionally not accepted as agent inputs.

Input Parameters

string
Replacement site title.
string
Replacement site domain.
string
required
Siteleaf site ID.
array
Replacement Jekyll content default definitions.
object
Replacement site-level custom metadata object.
string
Replacement site timezone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SITELEAF_UPSERT_SOURCECreate or replace one raw source file in a Siteleaf site.

Input Parameters

object
required
File content to upload as the new contents of the source file.
string
required
ID of the Siteleaf site where the source file will be stored.
string
required
Relative filename or nested path for the source file to create or replace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not