Creating a Guide

To create a guide under a KB board, use the createGuide mutation.

Note

• If you want to create a guide with an icon, you must pass the request as form-data. See Updating a Guide.
• You can add up to 500 guides, chapters, and articles. Contact Support to update the limit.

Fields

Use the below fields information to create a guide under a KB board.

Example

To create an “Artificial Intelligence” guide under a KB board and add chapters and articles to it, use the createGuide mutation.

Create guide without an avatar

mutation {
  createGuide(guideInput: {nodeId: "board:AIBoard", title: "Artificial Intelligence", description: "About AI and its impact.", hidden: false}) {
    errors {
      __typename
      ... on PermissionDeniedError {
        fields
        message
      }
      ... on InvalidGuideError {
        fields
        message
      }
      ... on MaximumEntriesAdded {
        fields
        limit
      }
      ... on GuideNotEnabledError {
        fields
        message
      }
      ... on ParentNodeError {
        fields
        message
      }
      ... on InvalidGuideTitle {
        fields
        message
      }
      ... on UploadLimitReached {
        fields
        message
      }
      ... on TooManyUploadedImages {
        fields
        message
      }
      ... on DisallowedImageFormat {
        fields
        message
      }
      ... on UploadTooLarge {
        fields
        message
      }
      ... on UploadFailed {
        fields
        message
      }
      ... on InvalidCropProps {
        fields
        message
      }
      ... on UnsupportedConversationStyleError {
        fields
        message
      }
      ... on GreaterThanMaxValueError {
        fields
        message
      }
      ... on UploadLimitReached {
        fields
        message
      }
    }
  }
}

Create guide with an avatar

curl -L 'https://[COMMUNITY DOMAIN]/t5/s/api/2.1/graphql' \
-H 'li-api-session-key: 6666777778888899999999FFFFFFGGGG' \
-H 'Content-Type: multipart/form-data' \
-F 'operations="{\"operationName\":\"CreateGuide\",\"variables\":{\"file\":{\"avatar\":{\"file\":null,\"cropProps\":{\"positionX\":0.5,\"positionY\":0.5,\"relativeWidth\":0.5,\"relativeHeight\":1,\"scale\":1,\"relativeX\":0,\"relativeY\":0}},\"nodeId\":\"board:tr-books\",\"title\":\"About T-bact\",\"description\":\"This guide is about T- bact3 medicine.\",\"hidden\":true}},\"query\":\"mutation CreateGuide(\$file: GuideInput\!) {\\n  createGuide(guideInput: \$file) {\\n    errors {\\n      __typename\\n      ... on MaximumEntriesAdded {\\n        limit\\n        __typename\\n      }\\n    }\\n    __typename\\n  }\\n}\\n\"}"' \
-F 'map="{\"1\":[\"variables.file.avatar.file\"]}"' \
-F '1=@"/Users/[USERNAME]/Downloads/Icon.png"' \

GraphQL response:

{
    "data": {
        "createGuide": {
            "errors": null
        }
    }
}