search_livedoc_templates

🚧
Early Access
This tool is in Early Access and is not enabled for all tenants yet. Contact your Customer Success Manager to request access.

Name: search_livedoc_templates

Description: Search for LiveDoc templates to generate personalized documents. Returns relevant templates ranked by relevance score and displays them in an interactive selector.

Schema

{
  "type": "object",
  "properties": {
    "searchText": {
      "type": "string",
      "description": "Broad text search term applied across title, description, versionNotes, body, and customPropertyValues. Example: 'template'."
    },
    "orderBy": {
      "type": "array",
      "description": "Sort attributes and directions.",
      "items": {
        "type": "object",
        "properties": {
          "attr": {
            "type": "string",
            "description": "Attribute to sort by, e.g. 'modifiedDate'."
          },
          "direction": {
            "type": "string",
            "description": "Sort direction, e.g. 'ASC' or 'DESC'."
          }
        }
      }
    },
    "page": {
      "type": "object",
      "description": "Paging settings. Omitted defaults to { size: 10, from: 0 }.",
      "properties": {
        "size": {
          "type": "integer",
          "default": 10
        },
        "from": {
          "type": "integer",
          "default": 0
        }
      }
    },
    "userId": {
      "type": "string",
      "description": "User identifier for the search context. Provide only when the caller's JWT bearer token does not already identify the user."
    }
  },
  "required": [
    "searchText"
  ]
}

{
  "type": "object",
  "properties": {
    "queryTimeInMs": {
      "type": "integer",
      "description": "Time spent executing the search query, in milliseconds."
    },
    "serviceTimeInMs": {
      "type": "integer",
      "description": "Total service processing time, in milliseconds."
    },
    "totalCount": {
      "type": "integer",
      "description": "Total number of templates found."
    },
    "documents": {
      "type": "array",
      "description": "Matching templates.",
      "items": {
        "type": "object",
        "properties": {
          "contentId": {
            "type": "string"
          },
          "contentVersionId": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          },
          "versionNotes": {
            "type": [
              "string",
              "null"
            ]
          },
          "format": {
            "type": [
              "string",
              "null"
            ]
          },
          "majorVersion": {
            "type": "integer"
          },
          "minorVersion": {
            "type": "integer"
          },
          "teamsite": {
            "type": [
              "string",
              "null"
            ]
          },
          "contentTypes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "contentProfiles": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "profileVersionIds": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "size": {
            "type": "integer"
          },
          "thumbnailId": {
            "type": [
              "string",
              "null"
            ]
          },
          "sourceBlobId": {
            "type": [
              "string",
              "null"
            ]
          },
          "modifiedDate": {
            "type": [
              "string",
              "null"
            ]
          },
          "createdDate": {
            "type": [
              "string",
              "null"
            ]
          },
          "versionCreatedDate": {
            "type": [
              "string",
              "null"
            ]
          },
          "publishDate": {
            "type": [
              "string",
              "null"
            ]
          },
          "expireDate": {
            "type": [
              "string",
              "null"
            ]
          },
          "contentSources": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}