⚠️ This documentation pertains to a preview endpoint. This feature is not yet ready for API consumption and may change.
For inquiries or feedback, please contact us at Glean.

Execute Action Tool

post/executeactiontool

Executes an Action tool with the specified parameters.

SecurityBearerAuth
Request
query Parameters
timezoneOffset
integer

The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.

Request Body schema: application/json
required

Execute Action Tool request

name
required
string

The name of the tool.

actionInstanceId
string

Unique identifier of an action instance.

object

The parameters to be passed to the tool for action.

Responses
200

OK

Response Schema: application/json
error
string

Error message, if any, when executing the action.

message
string

A descriptive message about the execution of the action tool.

rawExternalResponse
string

The raw response received from the external server.

resultURL
string

The URL, if any, pointing to the output generated by the Action Tool after executing an action.

title
string

The title, if any, of the output generated by the Action Tool after executing an action.

400

Invalid request

401

Not Authorized

429

Too Many Requests

500

Internal Server Error

Request samples
application/json
{
  • "name": "string",
  • "actionInstanceId": "string",
  • "parameters": {
    • "property1": {
      • "type": "UNKNOWN",
      • "displayName": "string",
      • "value": "string",
      • "label": "string",
      • "isRequired": true,
      • "description": "string",
      • "possibleValues": [
        • {
          • "value": "string",
          • "label": "string"
          }
        ]
      },
    • "property2": {
      • "type": "UNKNOWN",
      • "displayName": "string",
      • "value": "string",
      • "label": "string",
      • "isRequired": true,
      • "description": "string",
      • "possibleValues": [
        • {
          • "value": "string",
          • "label": "string"
          }
        ]
      }
    }
}
Response samples
application/json
{
  • "message": "string",
  • "error": "string",
  • "rawExternalResponse": "string",
  • "resultURL": "string",
  • "title": "string"
}