curl --request PUT \
  --url https://{domain}-be.glean.com/api/tools/v1/tool/{toolName}/manifest \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "RETRIEVAL",
  "name": "<string>",
  "displayName": "<string>",
  "toolId": "<string>",
  "displayDescription": "<string>",
  "logoUrl": "<string>",
  "objectName": [
    "HR ticket",
    "Email",
    "Chat message"
  ],
  "knowledgeType": "NEUTRAL_KNOWLEDGE",
  "createdBy": {
    "name": "<string>",
    "obfuscatedId": "<string>"
  },
  "lastUpdatedBy": {
    "name": "<string>",
    "obfuscatedId": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "lastUpdatedAt": "2023-11-07T05:31:56Z",
  "writeActionType": "REDIRECT",
  "authType": "NONE",
  "auth": {
    "isOnPrem": true,
    "usesCentralAuth": true,
    "type": "NONE",
    "grantType": "AUTH_CODE",
    "status": "AWAITING_AUTH",
    "client_url": "<string>",
    "scopes": [
      "<string>"
    ],
    "audiences": [
      "<string>"
    ],
    "authorization_url": "<string>",
    "lastAuthorizedAt": "2023-11-07T05:31:56Z"
  },
  "permissions": {
    "write": {
      "scopeType": "GLOBAL",
      "create": true,
      "update": true,
      "delete": true
    }
  },
  "usageInstructions": "<string>",
  "isSetupFinished": true,
  "description": "<string>",
  "enablePreview": true,
  "actionType": "REDIRECT",
  "exampleQueries": [
    "<string>"
  ]
}'
{
  "message": "<string>"
}

Path Parameters

toolName
string
required

Name of the tool.

Body

application/json

The manifest for a tool that can be used to augment Glean Assistant.

type
enum<string>
required

The type of tool.

Available options:
RETRIEVAL,
ACTION
name
string
required

Unique identifier for the tool. Name should be understandable by the LLM, and will be used to invoke a tool.

displayName
string
required

Human understandable name of the tool. Max 50 characters.

displayDescription
string
required

Description of the tool meant for a human.

description
string

Description tailored to an LLM describing how to use the tool. 8,000 character max.

enablePreview
boolean
default:true

Valid only for ACTION tools. If true, enable default preview and confirmation flow If false, directly execute the action.

actionType
enum<string>

Valid only for ACTION tools. Represents the type of action tool REDIRECT - The client renders the URL which contains information for carrying out the action. EXECUTION - Send a request to an external server and execute the action.

Available options:
REDIRECT,
EXECUTION
exampleQueries
string[]

Example queries that can be used to invoke the tool.

toolId
string

An opaque id which is unique identifier for the tool.

logoUrl
string

URL used to fetch the logo.

objectName
string

Name of the generated object. This will be used to indicate to the end user what the generated object contains.

Example:
["HR ticket", "Email", "Chat message"]
knowledgeType
enum<string>

Indicates the kind of knowledge a tool would access or modify.

Available options:
NEUTRAL_KNOWLEDGE,
COMPANY_KNOWLEDGE,
WORLD_KNOWLEDGE
createdBy
object
lastUpdatedBy
object
createdAt
string

The time the tool was created in ISO format (ISO 8601)

lastUpdatedAt
string

The time the tool was last updated in ISO format (ISO 8601)

writeActionType
enum<string>

Valid only for write actions. Represents the type of write action. REDIRECT - The client renders the URL which contains information for carrying out the action. EXECUTION - Send a request to an external server and execute the action.

Available options:
REDIRECT,
EXECUTION
authType
enum<string>

The type of authentication being used. Use 'OAUTH_*' when Glean calls an external API (e.g., Jira) on behalf of a user to obtain an OAuth token. 'OAUTH_ADMIN' utilizes an admin token for external API calls on behalf all users. 'OAUTH_USER' uses individual user tokens for external API calls. 'DWD' refers to domain wide delegation.

Available options:
NONE,
OAUTH_USER,
OAUTH_ADMIN,
API_KEY,
BASIC_AUTH,
DWD
auth
object

Config for tool's authentication method.

permissions
object
usageInstructions
string

Usage instructions for the LLM to use this action.

isSetupFinished
boolean

Whether this action has been fully configured and validated.

Response

200
application/json
Manifest successfully uploaded.
message
string

Message detailing the outcome of the operation.