# Griptape

Griptape is a comprehensive platform offering tools and frameworks for building, deploying, and scaling generative AI applications.

- **Category:** artificial intelligence
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 144
- **Triggers:** 0
- **Slug:** `GRIPTAPE`
- **Version:** 20260312_00

## Tools

### Assistant Creation

**Slug:** `GRIPTAPE_ASSISTANT_CREATION`

Tool to create a new assistant. Use when you need to register a uniquely named assistant in Griptape Cloud before initiating runs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the assistant. Must be 1-200 characters. |
| `input` | string | No | Default input specification or prompt template for the assistant. |
| `model` | string | No | LLM model identifier to use. If omitted, uses the account default model. |
| `tool_ids` | array | No | List of tool UUIDs to enable for this assistant. |
| `description` | string | No | Brief description of the assistant's purpose. Max 200 characters. |
| `ruleset_ids` | array | No | List of ruleset UUIDs to apply to this assistant for behavior constraints. |
| `retriever_ids` | array | No | List of retriever UUIDs to attach for document retrieval. |
| `structure_ids` | array | No | List of structure UUIDs for execution workflows. |
| `knowledge_base_ids` | array | No | List of knowledge base UUIDs to connect to this assistant for RAG capabilities. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Assistants

**Slug:** `GRIPTAPE_ASSISTANT_LISTING`

Tool to list all assistants. Use after authenticating with Griptape Cloud to retrieve available assistants. Supports optional pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of assistants to return. Must be >= 1. |
| `offset` | integer | No | Number of assistants to skip for pagination. Must be >= 0. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel Assistant Run

**Slug:** `GRIPTAPE_ASSISTANT_RUN_CANCELLATION`

Tool to cancel an ongoing assistant run. Use when you need to stop a run prematurely after confirming the run ID is valid.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `assistant_run_id` | string | Yes | The unique identifier (UUID) of the assistant run to cancel. This run should ideally still be in progress (QUEUED or RUNNING status). If the run is already in a terminal state (SUCCEEDED, FAILED, CANCELLED), the cancellation will return the current terminal status. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Assistant Run Creation

**Slug:** `GRIPTAPE_ASSISTANT_RUN_CREATION`

Creates a new assistant run to execute a conversation turn with a Griptape Cloud assistant. Use this action to send input messages to an assistant and initiate processing. The run is queued and processed asynchronously. Use the assistant run retrieval or result retrieval actions to get the output once complete.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `args` | array | No | List of string arguments to pass into the run. These are additional input artifacts for the assistant. |
| `input` | string | No | The input message or prompt to send to the assistant for this run. This is the primary way to interact with the assistant. |
| `stream` | boolean | No | Whether to enable streaming for run events. When True, use the assistant run events stream action to receive real-time updates. |
| `tool_ids` | array | No | List of tool IDs to enable for this run, overriding the assistant's default tools. |
| `thread_id` | string | No | The thread ID to associate with this run for maintaining conversation context across multiple runs. |
| `ruleset_ids` | array | No | List of ruleset IDs to apply for this run, overriding the assistant's default rulesets. |
| `assistant_id` | string | Yes | The unique identifier (UUID) of the assistant to run. Obtain this from the assistant listing action. |
| `structure_ids` | array | No | List of structure IDs to use for the run, overriding the assistant's default structures. |
| `knowledge_base_ids` | array | No | List of knowledge base IDs to query during the run, overriding the assistant's default knowledge bases. |
| `additional_tool_ids` | array | No | Additional tool IDs to include alongside the assistant's default tools. |
| `additional_ruleset_ids` | array | No | Additional ruleset IDs to include alongside the assistant's default rulesets. |
| `additional_structure_ids` | array | No | Additional structure IDs to include alongside the assistant's default structures. |
| `additional_knowledge_base_ids` | array | No | Additional knowledge base IDs to include alongside the assistant's default knowledge bases. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Assistant Run Error Details

**Slug:** `GRIPTAPE_ASSISTANT_RUN_ERROR_DETAILS`

Tool to fetch detailed error information for a specific assistant run. Use after an assistant run has failed to inspect error details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `run_id` | string | Yes | Unique identifier (UUID) of the assistant run to fetch error details for. Use this after an assistant run has failed to understand the error. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Assistant Runs

**Slug:** `GRIPTAPE_ASSISTANT_RUN_LISTING`

Tool to list all runs for a given assistant. Use when you need historical run executions for analysis after using the assistant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of runs to return, must be >= 1. |
| `offset` | integer | No | Number of runs to skip before returning results, must be >= 0. |
| `assistant_id` | string | Yes | UUID of the assistant to list runs for. Use the List Assistants action to find available assistant IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Assistant Run Logs Retrieval

**Slug:** `GRIPTAPE_ASSISTANT_RUN_LOGS_RETRIEVAL`

Retrieve the complete execution logs for an assistant run in Griptape Cloud. Returns a chronological timeline of events that occurred during the run, including: - Structure lifecycle events (start/finish) - Task execution events (start/finish with input/output) - Prompt events (model calls with token counts) - Streaming text chunks (for real-time output) Use this tool to debug runs, analyze performance (token usage), or inspect intermediate outputs. The assistant run must exist; use List Assistant Runs first to get valid run IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `assistant_run_id` | string | Yes | The UUID identifier of the assistant run whose execution logs should be retrieved. Obtain this ID from the assistant run creation response or by listing assistant runs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Assistant Run

**Slug:** `GRIPTAPE_ASSISTANT_RUN_RETRIEVAL`

Tool to retrieve an assistant run's status and details. Use when you need current status and metadata for a specific assistant run.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `assistant_run_id` | string | Yes | The unique identifier (UUID) of the assistant run to retrieve. Obtain this from the assistant run creation response or listing. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retry Assistant Run

**Slug:** `GRIPTAPE_ASSISTANT_RUN_RETRY`

Tool to attempt retrying a failed assistant run. If retry is not available (e.g., run hasn't failed or endpoint not supported), returns the current run status instead. Use when checking if a run can be retried or to get its current state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `run_id` | string | Yes | Unique identifier (UUID) of the assistant run to retry. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel Data Job

**Slug:** `GRIPTAPE_CANCEL_DATA_JOB`

Tool to cancel a running or queued data job. Use when you need to stop a data job that is in progress or queued.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data_job_id` | string | Yes | The unique identifier (UUID) of the data job to cancel. Must be in UUID format (e.g., '107e5aaf-61b9-4925-8f0d-f65312db31af'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Bucket

**Slug:** `GRIPTAPE_CREATE_BUCKET`

Tool to create a new bucket in Griptape Cloud. Use when you need to create storage buckets for organizing assets and data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the new bucket. Must be between 1 and 256 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Bucket Asset

**Slug:** `GRIPTAPE_CREATE_BUCKET_ASSET`

Tool to create a new asset in a Griptape Cloud bucket. Use when you need to add a new asset to a bucket by specifying its name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the asset to create. Must be between 1 and 256 characters. |
| `bucket_id` | string | Yes | The unique identifier (UUID) of the bucket to create the asset in. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Data Connector

**Slug:** `GRIPTAPE_CREATE_DATA_CONNECTOR`

Tool to create a new data connector in Griptape Cloud. Data connectors enable ingestion from various sources like web pages, Confluence, Google Drive, S3, or data lakes. After creation, the connector can automatically sync data to knowledge bases based on the configured schedule.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the data connector. Must be 1-200 characters. |
| `type` | string | Yes | Type of data connector. Must match the config field provided (e.g., 'webscraper', 'confluence', 'google_drive', 'structure', 's3', 'data_lake'). |
| `config` | object | Yes | Configuration object for the data connector. Exactly one connector type field must be populated based on the 'type' field. |
| `transforms` | array | No | Optional list of transform structures to apply to the data during ingestion. |
| `description` | string | No | Optional description of the data connector's purpose. Max 200 characters. |
| `schedule_expression` | string | No | Optional cron expression for scheduling automatic data syncs (e.g., 'cron(0 12 * * ? *)'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Data Connector Job

**Slug:** `GRIPTAPE_CREATE_DATA_CONNECTOR_JOB`

Tool to create a data job for a data connector in Griptape Cloud. Use when you need to trigger data ingestion or processing for a specific data connector. The job will be queued and executed asynchronously.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data_connector_id` | string | Yes | The unique identifier (UUID) of the data connector to create a job for. Must be a valid UUID v4 format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Export Job

**Slug:** `GRIPTAPE_CREATE_EXPORT_JOB`

Tool to create a new export job in Griptape Cloud. Use when you need to initiate an export operation with custom data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `metadata` | object | No | Optional metadata object with additional properties describing the export job. |
| `export_data` | object | Yes | Flexible JSON object containing the data to be exported. Can contain any valid JSON structure with no strict schema constraints. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Function

**Slug:** `GRIPTAPE_CREATE_FUNCTION`

Tool to create a new function in Griptape Cloud. Use when you need to register a new serverless function with optional code configuration and environment variables.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | Code configuration for the function. Can be GitHub, data lake, or default configuration. If omitted, function is created without code and can be configured later. |
| `name` | string | Yes | Name for the function. Must be 1-200 characters. |
| `env_vars` | array | No | List of environment variables for the function. |
| `description` | string | No | Brief description of the function's purpose. Max 200 characters. |
| `function_config_file` | string | No | Path to the function configuration file (1-200 characters). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Function Deployment

**Slug:** `GRIPTAPE_CREATE_FUNCTION_DEPLOYMENT`

Tool to create a new deployment for a function from a code source. Use when you need to deploy a function from a GitHub repository to Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `force` | boolean | No | If true, forces deployment even if another deployment is in progress. Use with caution. |
| `code_source` | object | Yes | Source code configuration specifying where to pull the code from (currently supports GitHub). |
| `function_id` | string | Yes | Unique identifier (UUID) of the function to create a deployment for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Import Job

**Slug:** `GRIPTAPE_CREATE_IMPORT_JOB`

Tool to create a new import job in Griptape Cloud. Use when you need to initiate a data import operation from a data lake asset (e.g., S3 bucket) into Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `metadata` | object | No | Additional key-value metadata for the import job. Can contain arbitrary information relevant to the import operation. |
| `import_type` | string | Yes | Type of import operation to perform. Required field that specifies the kind of data being imported. |
| `resource_suffix` | string | No | Suffix to append to imported resources. Useful for versioning or distinguishing multiple imports. |
| `data_lake_asset_path` | string | Yes | Path to the data lake asset (e.g., s3://bucket-name/path/to/data). Required field specifying the source location of data to import. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Integration

**Slug:** `GRIPTAPE_CREATE_INTEGRATION`

Tool to create a new integration in Griptape Cloud. Use when you need to register a new integration (slack, github_app, or webhook) to connect external services with assistants or structures.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the integration. Must be 1-200 characters. |
| `type` | string ("slack" | "github_app" | "webhook") | Yes | Type of integration to create (slack, github_app, or webhook). |
| `config` | string | Yes | Configuration object for the integration. Structure depends on the integration type. For webhook, use {'webhook': {}}. For slack, use {'slack': {}}. For github_app, use {'github_app': {}}. |
| `description` | string | No | Brief description of the integration's purpose. Max 200 characters. |
| `assistant_ids` | array | No | List of assistant UUIDs to associate with this integration. |
| `structure_ids` | array | No | List of structure UUIDs to associate with this integration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Knowledge Base

**Slug:** `GRIPTAPE_CREATE_KNOWLEDGE_BASE`

Tool to create a new knowledge base in Griptape Cloud. Use when you need to set up a vector store for document indexing and semantic search.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the knowledge base. Must be 1-200 characters. |
| `type` | string | Yes | Type of knowledge base. Must match the config type: 'pg_vector', 'gtc_pg_vector', 'gtc_hybrid_sql_pg_vector', or 'pgai_knowledge_base'. |
| `config` | string | Yes | Configuration object for the knowledge base. Type must match the 'type' field. For most cases, use an empty dict for the selected config type. |
| `transforms` | array | No | List of transforms to apply to the knowledge base. |
| `asset_paths` | array | No | List of asset paths to associate with this knowledge base. |
| `description` | string | No | Brief description of the knowledge base. Max 200 characters. |
| `embedding_model` | string | No | Embedding model to use. Options: 'text-embedding-ada-002' or 'text-embedding-3-small'. |
| `use_default_embedding_model` | boolean | No | Whether to use the default embedding model. If true, embedding_model field is ignored. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Knowledge Base Job

**Slug:** `GRIPTAPE_CREATE_KNOWLEDGE_BASE_JOB`

Tool to create a knowledge base job for ingesting data into a knowledge base. Use when you need to trigger data ingestion or processing for a specific knowledge base.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `knowledge_base_id` | string | Yes | The unique identifier (UUID) of the knowledge base to create a job for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Library

**Slug:** `GRIPTAPE_CREATE_LIBRARY`

Tool to create a new library in Griptape Cloud. Use when you need to organize data connectors and knowledge bases for an assistant to use.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the library. Must be 1-64 characters. |
| `description` | string | No | Brief description of the library's purpose. Max 256 characters. |
| `data_connector_ids` | array | Yes | List of data connector UUIDs to include in this library. Data connectors define data sources to ingest. |
| `knowledge_base_configs` | array | Yes | List of knowledge base configurations. Each config must specify exactly one backend type (pg_vector, gtc_pg_vector, gtc_hybrid_sql_pg_vector, or pgai_knowledge_base). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Model Configuration

**Slug:** `GRIPTAPE_CREATE_MODEL`

Tool to create a new model configuration in Griptape Cloud. Use when you need to register a new model with specific authentication and configuration settings before using it in assistants or other Griptape resources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `active` | boolean | No | Whether the model configuration should be active. If not specified, defaults to true. |
| `kwargs` | object | No | Additional keyword arguments for the model configuration (e.g., temperature, max_tokens). |
| `model_name` | string | Yes | Name of the model to configure (e.g., 'gpt-4', 'claude-3-opus'). Must be 1-1000 characters. |
| `model_type` | string ("chat" | "embedding" | "rerank" | "image_generation" | "unknown") | Yes | Type of the model - determines how it will be used in Griptape Cloud. |
| `description` | string | No | Brief description of the model configuration and its intended use case. |
| `auth_config_id` | string | Yes | UUID of the authentication configuration to use for this model. Must be a valid UUID v4 format. Obtain this from auth config creation or listing responses. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Model Auth Config

**Slug:** `GRIPTAPE_CREATE_MODEL_AUTH_CONFIG`

Tool to create a model authentication configuration in Griptape Cloud. Use when you need to set up new authentication for a model API endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the model auth config (1-200 characters). |
| `base_url` | string | Yes | Base URL for the model API endpoint. |
| `api_key_secret_id` | string | Yes | UUID of the API key secret to use for authentication. Must be a valid UUID v4 format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Organization API Key

**Slug:** `GRIPTAPE_CREATE_ORGANIZATION_API_KEY`

Tool to create a new API key for a specific organization. Use when you need to generate a new API key for authentication purposes. The API key value is only returned once during creation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the API key. Must be between 1 and 200 characters. |
| `organization_id` | string | Yes | The unique identifier (UUID) of the organization to create the API key for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Retriever

**Slug:** `GRIPTAPE_CREATE_RETRIEVER`

Tool to create a new retriever in Griptape Cloud. Use when you need to create a retriever with associated components for document retrieval capabilities.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the retriever. Must be 1-64 characters. |
| `description` | string | No | Description of the retriever's purpose. Must be 1-256 characters if provided. |
| `retriever_components` | array | No | List of new retriever component objects to create for this retriever. Each component must have 'name' and 'type' fields. |
| `retriever_component_ids` | array | No | List of existing retriever component UUIDs to associate with this retriever. Each ID must be a valid UUID v4 format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Rule

**Slug:** `GRIPTAPE_CREATE_RULE`

Tool to create a new rule in Griptape Cloud. Use when you need to define behavioral guidelines or constraints for AI assistants.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the rule. Must be 1-200 characters. This identifies the rule within the Griptape Cloud. |
| `rule` | string | Yes | The rule content or definition text. Must be 1-2000 characters. This is the actual behavioral guideline or constraint. |
| `metadata` | object | No | Optional key-value metadata to associate with the rule. Can contain arbitrary data for organizational purposes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Secret

**Slug:** `GRIPTAPE_CREATE_SECRET`

Tool to create a new secret in Griptape Cloud. Use when you need to store sensitive information like API keys, passwords, or tokens.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the secret. Must be between 1 and 200 characters. |
| `value` | string | Yes | Value of the secret. Must be between 1 and 200 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Structure

**Slug:** `GRIPTAPE_CREATE_STRUCTURE`

Tool to create a new structure in Griptape Cloud. Use when you need to register a workflow or data processing pipeline that can be deployed and executed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | Code source configuration. Can be GitHub, data lake, or default. Specify exactly one of the source types. |
| `name` | string | Yes | Name for the structure. Must be 1-200 characters. |
| `env_vars` | array | No | List of environment variables to configure for the structure. |
| `description` | string | No | Brief description of the structure's purpose. Max 200 characters. |
| `webhook_enabled` | boolean | No | Whether to enable webhook functionality for this structure. |
| `structure_config_file` | string | No | Path to the structure configuration file. Max 200 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Structure Deployment

**Slug:** `GRIPTAPE_CREATE_STRUCTURE_DEPLOYMENT`

Tool to create a new deployment for a structure. Use when you need to deploy a structure from a GitHub repository to Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `force` | boolean | No | Force deployment even if a deployment is already in progress. Use with caution. |
| `code_source` | object | Yes | Code source configuration specifying where to deploy the structure code from. |
| `structure_id` | string | Yes | Unique identifier (UUID) of the structure to deploy. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Thread

**Slug:** `GRIPTAPE_CREATE_THREAD`

Tool to create a new thread in Griptape Cloud. Use when you need to start a new conversation thread for organizing messages and interactions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the thread. Must be 1-200 characters. |
| `alias` | string | No | Alias for the thread. Must be 1-200 characters if provided. |
| `messages` | array | No | Optional list of messages to initialize the thread with. Each message requires both input and output. |
| `metadata` | object | No | Optional metadata to associate with the thread. Can contain arbitrary key-value pairs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Thread Message

**Slug:** `GRIPTAPE_CREATE_THREAD_MESSAGE`

Tool to create a new message in a specific thread. Use when you need to add a message with input and output content to a conversation thread in Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `input` | string | Yes | The input content of the message. |
| `output` | string | Yes | The output content or response of the message. |
| `metadata` | object | No | Additional metadata to associate with the message. |
| `thread_id` | string | Yes | The unique identifier (UUID) of the thread to create the message in. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tool Deployment

**Slug:** `GRIPTAPE_CREATE_TOOL_DEPLOYMENT`

Create a new deployment for a tool from a GitHub repository. Use when you need to deploy or update tool code from a GitHub source. The deployment process is asynchronous - use the Get Tool Deployment Status action to poll for completion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `force` | boolean | No | Whether to force deployment even if there are no code changes. Set to true to redeploy with the same code. |
| `tool_id` | string | Yes | Unique identifier (UUID) of the tool to deploy. Obtain this from the List Tools or Create Tool action. |
| `code_source` | object | Yes | Source code configuration specifying the GitHub repository to deploy from. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete API Key

**Slug:** `GRIPTAPE_DELETE_API_KEY`

Tool to delete an API key by ID. Use when you need to permanently remove an API key from Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `api_key_id` | string | Yes | Unique identifier (UUID) of the API key to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Assistant

**Slug:** `GRIPTAPE_DELETE_ASSISTANT`

Tool to delete an assistant by ID. Use when you need to permanently remove an assistant from Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `assistant_id` | string | Yes | Unique identifier (UUID) of the assistant to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Bucket

**Slug:** `GRIPTAPE_DELETE_BUCKET`

Tool to delete a bucket by ID. Use when you need to remove a specific bucket from Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bucket_id` | string | Yes | The unique identifier (UUID) of the bucket to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Bucket Asset

**Slug:** `GRIPTAPE_DELETE_BUCKET_ASSET`

Tool to delete a specific asset from a Griptape Cloud bucket. Use when you need to remove an asset from a bucket by name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the asset to delete from the bucket. |
| `bucket_id` | string | Yes | The unique identifier (UUID) of the bucket containing the asset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Data Connector

**Slug:** `GRIPTAPE_DELETE_DATA_CONNECTOR`

Tool to delete a data connector. Use when you need to permanently remove a data connector from Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data_connector_id` | string | Yes | The unique identifier (UUID) of the data connector to delete. This operation is irreversible and will permanently remove the data connector. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Function

**Slug:** `GRIPTAPE_DELETE_FUNCTION`

Tool to delete a function from Griptape Cloud. Use when you need to permanently remove a function by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `function_id` | string | Yes | Unique identifier (UUID) of the function to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Integration

**Slug:** `GRIPTAPE_DELETE_INTEGRATION`

Tool to delete an integration by ID. Use when you need to permanently remove an integration from Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `integration_id` | string | Yes | The unique identifier (UUID) of the integration to delete. This will permanently remove the integration from Griptape Cloud. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Knowledge Base

**Slug:** `GRIPTAPE_DELETE_KNOWLEDGE_BASE`

Tool to delete a Knowledge Base from Griptape Cloud. Use when you need to permanently remove a knowledge base and all its associated data. This operation cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `knowledge_base_id` | string | Yes | The unique identifier (UUID) of the Knowledge Base to delete. Can be found in the Griptape Cloud console Config tab. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Library

**Slug:** `GRIPTAPE_DELETE_LIBRARY`

Tool to delete a library from Griptape Cloud. Use when you need to permanently remove a library resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `library_id` | string | Yes | Unique identifier (UUID) of the library to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Message

**Slug:** `GRIPTAPE_DELETE_MESSAGE`

Tool to delete a message by its ID. Use when you need to remove a specific message from Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message_id` | string | Yes | The unique identifier (UUID) of the message to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Model Configuration

**Slug:** `GRIPTAPE_DELETE_MODEL`

Tool to delete a model configuration from Griptape Cloud. Use when you need to permanently remove a model configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_config_id` | string | Yes | The unique identifier (UUID) of the model configuration to delete. This will permanently remove the model configuration from Griptape Cloud. Obtain this ID from model listing or creation responses. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Model Auth Config

**Slug:** `GRIPTAPE_DELETE_MODEL_AUTH_CONFIG`

Tool to delete a model auth config by ID. Use when you need to permanently remove a model authentication configuration from Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `auth_config_id` | string | Yes | Unique identifier (UUID) of the model auth config to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Rule

**Slug:** `GRIPTAPE_DELETE_RULE`

Tool to delete a rule by its ID. Use when you need to permanently remove a rule from Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rule_id` | string | Yes | Unique identifier (UUID) of the rule to delete. The rule must exist in the Griptape Cloud and belong to your organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Ruleset

**Slug:** `GRIPTAPE_DELETE_RULESET`

Tool to permanently delete a ruleset from Griptape Cloud by its ID. Use when you need to remove a ruleset and all its associated rules. This operation cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ruleset_id` | string | Yes | Unique identifier (UUID) of the ruleset to delete. This permanently removes the ruleset and its associated rules from Griptape Cloud. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Secret

**Slug:** `GRIPTAPE_DELETE_SECRET`

Tool to delete a secret from Griptape Cloud. Use when you need to permanently remove a secret by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `secret_id` | string | Yes | The unique identifier (UUID) of the secret to delete. This operation is irreversible. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Structure

**Slug:** `GRIPTAPE_DELETE_STRUCTURE`

Tool to delete a structure from Griptape Cloud. Use when you need to permanently remove a structure by its ID. This operation is irreversible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `structure_id` | string | Yes | The unique identifier (UUID) of the structure to delete. This action is irreversible and will permanently remove the structure from your account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Thread

**Slug:** `GRIPTAPE_DELETE_THREAD`

Tool to delete a thread by its ID. Use when you need to permanently remove a conversation thread and all its associated messages from Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `thread_id` | string | Yes | The unique identifier (UUID) of the thread to delete. Once deleted, the thread and all its associated messages will be permanently removed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Tool

**Slug:** `GRIPTAPE_DELETE_TOOL`

Tool to delete a tool from Griptape Cloud. Use when you need to permanently remove a tool resource by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tool_id` | string | Yes | Unique identifier (UUID) of the tool to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get API Key

**Slug:** `GRIPTAPE_GET_API_KEY`

Tool to retrieve an API key's details. Use when you need to get information about a specific API key by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `api_key_id` | string | Yes | The unique identifier (UUID) of the API key to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Assistant

**Slug:** `GRIPTAPE_GET_ASSISTANT`

Tool to retrieve a specific assistant's details by ID. Use when you need detailed information about a particular assistant including its configuration, knowledge bases, and tools.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `assistant_id` | string | Yes | The unique identifier (UUID) of the assistant to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Billing Management URL

**Slug:** `GRIPTAPE_GET_BILLING_MANAGEMENT_URL`

Tool to retrieve the billing management portal URL. Use when you need to access or redirect users to the billing portal for subscription or payment management.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bucket

**Slug:** `GRIPTAPE_GET_BUCKET`

Tool to retrieve a bucket's details by its ID. Use when you need to fetch information about a specific bucket in Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bucket_id` | string | Yes | The unique identifier (UUID) of the bucket to retrieve. This is a UUID v4 format identifier (e.g., '599a4d24-cda7-4ccf-9b72-6484294c6c87'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bucket Asset

**Slug:** `GRIPTAPE_GET_BUCKET_ASSET`

Tool to retrieve a specific asset from a Griptape Cloud bucket. Use when you need to fetch asset metadata or contents from a bucket by name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the asset to retrieve from the bucket. |
| `bucket_id` | string | Yes | The unique identifier (UUID) of the bucket containing the asset. |
| `include_contents` | boolean | No | Set to true to include the asset contents in the response. Set to false to retrieve only metadata. Defaults to false if not specified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bucket Asset URL

**Slug:** `GRIPTAPE_GET_BUCKET_ASSET_URL`

Tool to generate a signed URL for accessing or uploading bucket assets. Use when you need a temporary URL to GET (download) or PUT (upload) an asset in a Griptape Cloud bucket.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name or path of the asset in the bucket for which to generate a signed URL. |
| `bucket_id` | string | Yes | The unique identifier (UUID) of the bucket containing the asset. |
| `operation` | string ("PUT" | "GET") | No | Enum for asset URL operation types. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Configuration

**Slug:** `GRIPTAPE_GET_CONFIG`

Tool to retrieve Griptape Cloud configuration. Use when you need to access data lake settings or Google Drive connector configuration.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Credits Balance

**Slug:** `GRIPTAPE_GET_CREDITS_BALANCE`

Tool to retrieve the current credits balance. Use when you need to check available credits for billing or usage tracking.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Data Connector

**Slug:** `GRIPTAPE_GET_DATA_CONNECTOR`

Tool to retrieve a data connector's configuration and details from Griptape Cloud. Use when you need information about a specific data connector including its type, configuration, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data_connector_id` | string | Yes | The unique identifier (UUID) of the data connector to retrieve. Must be a valid UUID v4 format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Data Job

**Slug:** `GRIPTAPE_GET_DATA_JOB`

Tool to retrieve a data job's status and details by its ID. Use when you need to check the current status, ingestion progress, or errors for a specific data job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data_job_id` | string | Yes | The unique identifier (UUID) of the data job to retrieve. Must be in UUID format (e.g., '85e0625a-18e4-410a-bf28-b8cb745f5141'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Export Job

**Slug:** `GRIPTAPE_GET_EXPORT_JOB`

Tool to retrieve an export job by ID. Use when you need to check the status or details of an export operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `export_job_id` | string | Yes | Unique identifier (UUID) of the export job to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Function

**Slug:** `GRIPTAPE_GET_FUNCTION`

Tool to retrieve a function's details. Use when you need to get configuration, environment variables, or metadata for a specific function in Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `function_id` | string | Yes | The unique identifier (UUID) of the function to retrieve. Obtain this from function creation or listing. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Import Job

**Slug:** `GRIPTAPE_GET_IMPORT_JOB`

Tool to retrieve an import job's status and details. Use when you need to check the current status and metadata for a specific import job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `import_job_id` | string | Yes | The unique identifier (UUID) of the import job to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Integration

**Slug:** `GRIPTAPE_GET_INTEGRATION`

Tool to retrieve a specific integration's details by ID. Use when you need detailed information about a particular integration including its configuration, associated assistants, and structures.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `integration_id` | string | Yes | The unique identifier (UUID) of the integration to retrieve. This is a UUID v4 format identifier (e.g., '897003ec-49cd-4e5f-9ace-c5c721ce2222'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Knowledge Base

**Slug:** `GRIPTAPE_GET_KNOWLEDGE_BASE`

Tool to retrieve a knowledge base's configuration and details from Griptape Cloud. Use when you need information about a specific knowledge base including its type, configuration, embedding model, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `knowledge_base_id` | string | Yes | The unique identifier (UUID) of the knowledge base to retrieve. Must be a valid UUID v4 format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Knowledge Base Job

**Slug:** `GRIPTAPE_GET_KNOWLEDGE_BASE_JOB`

Tool to retrieve a knowledge base job's status and details by its ID. Use when you need to check the current status, ingestion progress, or errors for a specific knowledge base job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `knowledge_base_job_id` | string | Yes | The unique identifier (UUID) of the knowledge base job to retrieve. Must be in UUID format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Knowledge Base Search

**Slug:** `GRIPTAPE_GET_KNOWLEDGE_BASE_SEARCH`

Tool to retrieve details of a specific knowledge base search by its ID. Use when you need to fetch results of a previously executed knowledge base search.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `knowledge_base_search_id` | string | Yes | The unique identifier (UUID) of the knowledge base search to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Library

**Slug:** `GRIPTAPE_GET_LIBRARY`

Tool to retrieve a specific library's details by ID. Use when you need detailed information about a library including its associated assistant, retrievers, knowledge bases, and data connectors.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `library_id` | string | Yes | The unique identifier (UUID) of the library to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Message

**Slug:** `GRIPTAPE_GET_MESSAGE`

Tool to retrieve a specific message's details by ID. Use when you need detailed information about a particular message from a thread.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message_id` | string | Yes | The unique identifier (UUID) of the message to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Model Configuration

**Slug:** `GRIPTAPE_GET_MODEL`

Tool to retrieve a model configuration's details by its ID. Use when you need to get information about a specific model configuration in Griptape Cloud, including its name, type, authentication settings, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_config_id` | string | Yes | The unique identifier (UUID) of the model configuration to retrieve. This is a UUID v4 format identifier. Obtain this from model creation or listing responses. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Model Auth Config

**Slug:** `GRIPTAPE_GET_MODEL_AUTH_CONFIG`

Tool to retrieve a model auth config by ID. Use when you need to get configuration details for model authentication in Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `auth_config_id` | string | Yes | Unique identifier (UUID) of the model auth config to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Organization

**Slug:** `GRIPTAPE_GET_ORGANIZATION`

Tool to retrieve an organization's details by its ID. Use when you need information about a specific organization including its configuration, entitlement, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `organization_id` | string | Yes | The unique identifier (UUID) of the organization to retrieve. Must be a valid UUID v4 format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Retriever

**Slug:** `GRIPTAPE_GET_RETRIEVER`

Tool to retrieve a retriever's details by its ID. Use when you need to fetch information about a specific retriever in Griptape Cloud, including its components and configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `retriever_id` | string | Yes | The unique identifier (UUID) of the retriever to retrieve. This is a UUID v4 format identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Retriever Component

**Slug:** `GRIPTAPE_GET_RETRIEVER_COMPONENT`

Tool to retrieve a retriever component's details by its ID. Use when you need to fetch information about a specific retriever component in Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `retriever_component_id` | string | Yes | The unique identifier (UUID) of the retriever component to retrieve. This is a UUID v4 format identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Rule

**Slug:** `GRIPTAPE_GET_RULE`

Tool to retrieve a specific rule's details by ID. Use when you need detailed information about a particular rule including its content, metadata, and timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rule_id` | string | Yes | Unique identifier (UUID) of the rule to retrieve. The rule must exist in the Griptape Cloud and belong to your organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Ruleset

**Slug:** `GRIPTAPE_GET_RULESET`

Tool to retrieve a specific ruleset's details by ID. Use when you need detailed information about a particular ruleset including its name, rules, metadata, and timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ruleset_id` | string | Yes | Unique identifier (UUID) of the ruleset to retrieve. The ruleset must exist in Griptape Cloud and belong to your organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Ruleset by Alias

**Slug:** `GRIPTAPE_GET_RULESET_BY_ALIAS`

Retrieve a ruleset from Griptape Cloud by its unique alias identifier. The alias is typically an auto-generated 32-character hash (e.g., 'e9990de9925a40d1b8fce8455c63651f') created when the ruleset was first created, unless a custom alias was provided during creation. Returns the full ruleset details including name, metadata, rule IDs, and timestamps. Returns an empty list if no ruleset matches the given alias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `alias` | string | Yes | The unique alias identifier of the ruleset to retrieve. This is an auto-generated hash (e.g., 'e9990de9925a40d1b8fce8455c63651f') assigned when the ruleset is created, unless a custom alias was provided during creation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Secret

**Slug:** `GRIPTAPE_GET_SECRET`

Tool to retrieve a secret's details from Griptape Cloud. Use when you need information about a specific secret including its name, organization, and usage timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `secret_id` | string | Yes | The unique identifier (UUID) of the secret to retrieve. Must be a valid UUID v4 format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Structure

**Slug:** `GRIPTAPE_GET_STRUCTURE`

Tool to retrieve a structure's configuration and details from Griptape Cloud. Use when you need detailed information about a specific structure including its deployment, environment variables, and code configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `structure_id` | string | Yes | The unique identifier (UUID) of the structure to retrieve. Must be a valid UUID v4 format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Structures Dashboard

**Slug:** `GRIPTAPE_GET_STRUCTURES_DASHBOARD`

Tool to retrieve dashboard metrics for structures. Use when you need analytics on deployments, runs, errors, durations, and token usage.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `period` | string ("1m" | "1h" | "1d" | "1w") | No | Time period for dashboard aggregation. |
| `end_time` | string | No | End time for the dashboard time range in ISO 8601 format (e.g., '2024-01-31T23:59:59Z'). If not provided, uses current time. |
| `start_time` | string | No | Start time for the dashboard time range in ISO 8601 format (e.g., '2024-01-01T00:00:00Z'). If not provided, uses system default. |
| `structure_ids` | string | No | Comma-separated list of structure IDs to filter the dashboard metrics. If not provided, includes all structures. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Thread

**Slug:** `GRIPTAPE_GET_THREAD`

Tool to retrieve a specific thread's details by ID. Use when you need detailed information about a particular conversation thread including its metadata and message statistics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `thread_id` | string | Yes | The unique identifier (UUID) of the thread to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tool

**Slug:** `GRIPTAPE_GET_TOOL`

Tool to retrieve a specific tool's details by ID. Use when you need detailed information about a particular tool including its configuration, environment variables, and deployment status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tool_id` | string | Yes | The unique identifier (UUID) of the tool to retrieve. Obtain this from tool creation or listing. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Usage

**Slug:** `GRIPTAPE_GET_USAGE`

Tool to retrieve current usage statistics. Use when you need to check bytes ingested, RAG queries, runtime seconds, and their respective limits for the billing period.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User

**Slug:** `GRIPTAPE_GET_USER`

Tool to retrieve a user's details by their ID. Use when you need information about a specific user including their email, name, and organization memberships.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | The unique identifier (UUID) of the user to retrieve. Must be a valid UUID v4 format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Assistant Run Events

**Slug:** `GRIPTAPE_LIST_ASSISTANT_RUN_EVENTS`

Tool to list events for an assistant run with pagination support. Use when you need to retrieve execution events in a paginated manner, as opposed to streaming them.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of events to return, must be >= 1. Use this to control page size. |
| `offset` | integer | No | Number of events to skip before returning results, must be >= 0. Use this with limit for pagination. |
| `assistant_run_id` | string | Yes | The unique identifier (UUID) of the assistant run to list events for. Obtain this from the assistant run creation response or listing. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Bucket Assets

**Slug:** `GRIPTAPE_LIST_BUCKET_ASSETS`

Tool to list assets in a bucket. Use when you need to retrieve files stored in a Griptape Cloud bucket. Supports pagination and filtering by name prefix/postfix.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination, must be >= 1. |
| `prefix` | string | No | Filter assets by name prefix. Only assets whose names start with this string will be returned. |
| `postfix` | string | No | Filter assets by name postfix. Only assets whose names end with this string will be returned. |
| `bucket_id` | string | Yes | UUID of the bucket to list assets for. Use the List Buckets action to find available bucket IDs. |
| `page_size` | integer | No | Number of assets per page, must be >= 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Buckets

**Slug:** `GRIPTAPE_LIST_BUCKETS`

Tool to list all buckets in Griptape Cloud. Use after authenticating to retrieve available buckets with pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `page_size` | integer | No | Number of buckets to return per page. Must be >= 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Connections

**Slug:** `GRIPTAPE_LIST_CONNECTIONS`

Tool to list all connections. Use after authenticating with Griptape Cloud to retrieve available connections. Supports optional pagination and type filtering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `type` | string | No | Filter connections by type (e.g., 'database', 'api', 'storage'). |
| `page_size` | integer | No | Number of connections to return per page. Must be >= 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Data Connectors

**Slug:** `GRIPTAPE_LIST_DATA_CONNECTORS`

Tool to list all data connectors. Use when you need to discover available data connectors and their configurations in Griptape Cloud. Supports pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `page_size` | integer | No | Number of data connectors per page. Must be >= 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Embedding Drivers

**Slug:** `GRIPTAPE_LIST_EMBEDDING_DRIVERS`

Tool to list available embedding drivers. Use when you need to retrieve supported drivers and their models before embedding text.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `endpoint_override` | string | No | Optional endpoint path or alias to query for drivers. Examples: 'embedding/drivers', 'embedding', 'models', 'info', '/models'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Export Jobs

**Slug:** `GRIPTAPE_LIST_EXPORT_JOBS`

Tool to list export jobs from Griptape Cloud. Use when you need to view all export jobs with optional filtering by status and pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `status` | array | No | List of statuses to filter by (e.g., ['QUEUED', 'RUNNING', 'SUCCEEDED', 'FAILED', 'CANCELLED']). |
| `page_size` | integer | No | Number of export jobs to return per page. Must be >= 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Function Deployments

**Slug:** `GRIPTAPE_LIST_FUNCTION_DEPLOYMENTS`

Tool to list all deployments for a specific function. Use when you need to retrieve deployment history and status for a function in Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `page_size` | integer | No | Number of deployments to return per page. Must be >= 1. |
| `function_id` | string | Yes | Unique identifier (UUID) of the function to list deployments for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Functions

**Slug:** `GRIPTAPE_LIST_FUNCTIONS`

Tool to list all functions with optional pagination. Use when you need to discover available functions and their IDs in Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `page_size` | integer | No | Number of functions per page. Must be >= 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Import Jobs

**Slug:** `GRIPTAPE_LIST_IMPORT_JOBS`

Tool to list import jobs in Griptape Cloud. Use when you need to retrieve import jobs with optional filtering by status and pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `status` | array | No | List of statuses to filter import jobs by (e.g., ['PENDING', 'COMPLETED', 'FAILED']). If not provided, all import jobs are returned. |
| `page_size` | integer | No | Number of import jobs to return per page. Must be >= 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Integrations

**Slug:** `GRIPTAPE_LIST_INTEGRATIONS`

Tool to list all integrations. Use when you need to discover available integrations in Griptape Cloud. Supports optional pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination, must be >= 1. |
| `page_size` | integer | No | Number of integrations to return per page, must be >= 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Knowledge Base Jobs

**Slug:** `GRIPTAPE_LIST_KNOWLEDGE_BASE_JOBS`

Tool to list knowledge base jobs for a specific knowledge base. Use when you need to retrieve jobs with optional filtering by status and pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `status` | array | No | List of statuses to filter knowledge base jobs by (e.g., ['QUEUED', 'RUNNING', 'SUCCEEDED', 'FAILED']). If not provided, all jobs are returned. |
| `page_size` | integer | No | Number of knowledge base jobs to return per page. Must be >= 1. |
| `knowledge_base_id` | string | Yes | The unique identifier (UUID) of the knowledge base to list jobs for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Knowledge Base Queries

**Slug:** `GRIPTAPE_LIST_KNOWLEDGE_BASE_QUERIES`

Tool to list all queries made to a specific Griptape Cloud knowledge base. Use when you need to retrieve historical query records including query text, results, and metadata. Supports pagination for large result sets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination, must be >= 1. |
| `page_size` | integer | No | Number of queries per page, must be >= 1. |
| `knowledge_base_id` | string | Yes | UUID of the Knowledge Base to list queries for. Can be found in the Griptape Cloud console. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Knowledge Bases

**Slug:** `GRIPTAPE_LIST_KNOWLEDGE_BASES`

Tool to list all knowledge bases. Use to retrieve available knowledge bases in Griptape Cloud with optional pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `page_size` | integer | No | Number of knowledge bases to return per page. Must be >= 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Knowledge Base Searches

**Slug:** `GRIPTAPE_LIST_KNOWLEDGE_BASE_SEARCHES`

Tool to list all searches performed on a specific knowledge base. Use when you need to view the search history for a knowledge base.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `page_size` | integer | No | Number of searches to return per page. Must be >= 1. |
| `knowledge_base_id` | string | Yes | The unique identifier (UUID) of the knowledge base to list searches for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Libraries

**Slug:** `GRIPTAPE_LIST_LIBRARIES`

Tool to list all libraries in Griptape Cloud. Use after authenticating to retrieve available libraries with pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `page_size` | integer | No | Number of libraries to return per page. Must be >= 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Model Auth Configs

**Slug:** `GRIPTAPE_LIST_MODEL_AUTH_CONFIGS`

Tool to list all model authentication configurations with optional pagination. Use when you need to discover available model auth configs and their IDs in Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `page_size` | integer | No | Number of model auth configs per page. Must be >= 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Models

**Slug:** `GRIPTAPE_LIST_MODELS`

Tool to list all models in Griptape Cloud. Use when you need to discover available models and their configurations. Supports pagination and filtering by model type or default status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `default` | boolean | No | Filter to show only default models (true) or non-default models (false). |
| `page_size` | integer | No | Number of models per page. Must be >= 1. |
| `model_type` | string | No | Filter models by type (e.g., 'prompt', 'embedding', 'image', 'text'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Organization API Keys

**Slug:** `GRIPTAPE_LIST_ORGANIZATION_API_KEYS`

Tool to list all API keys in a specific organization. Use when you need to retrieve all API keys for an organization with optional pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `page_size` | integer | No | Number of API keys to return per page. Must be >= 1. |
| `organization_id` | string | Yes | The unique identifier (UUID) of the organization to list API keys for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Organizations

**Slug:** `GRIPTAPE_LIST_ORGANIZATIONS`

Tool to list all organizations in Griptape Cloud. Use after authenticating to retrieve available organizations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Retriever Components

**Slug:** `GRIPTAPE_LIST_RETRIEVER_COMPONENTS`

Tool to list all retriever components in Griptape Cloud. Use when you need to discover available retriever components and their configurations. Supports pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `page_size` | integer | No | Number of retriever components per page. Must be >= 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Retrievers

**Slug:** `GRIPTAPE_LIST_RETRIEVERS`

Tool to list all retrievers in Griptape Cloud. Use to retrieve available retrievers with optional pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `page_size` | integer | No | Number of retrievers to return per page. Must be >= 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Rules

**Slug:** `GRIPTAPE_LIST_RULES`

Tool to list all rules in Griptape Cloud with optional pagination and filtering. Use when you need to retrieve available rules and their details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `page_size` | integer | No | Number of rules to return per page. Must be >= 1. |
| `ruleset_id` | string | No | Filter rules by ruleset ID. Only returns rules belonging to the specified ruleset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Secrets

**Slug:** `GRIPTAPE_LIST_SECRETS`

Tool to list all secrets in Griptape Cloud. Use to retrieve available secrets with optional pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `page_size` | integer | No | Number of secrets to return per page. Must be >= 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Structure Deployments

**Slug:** `GRIPTAPE_LIST_STRUCTURE_DEPLOYMENTS`

Tool to list all deployments for a specific structure. Use when you need to retrieve deployment history and status for a structure in Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `status` | array | No | Comma-separated list of deployment statuses to filter by. Possible values: 'QUEUED', 'DEPLOYING', 'SUCCEEDED', 'FAILED', 'ERROR'. |
| `page_size` | integer | No | Number of deployments to return per page. Must be >= 1. |
| `structure_id` | string | Yes | Unique identifier (UUID) of the structure to list deployments for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Structure Runs

**Slug:** `GRIPTAPE_LIST_STRUCTURE_RUNS`

Tool to list all runs for a specific structure with optional pagination and status filtering. Use when you need to retrieve historical execution runs for a structure.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `status` | array | No | List of run statuses to filter by. Common statuses include: 'QUEUED', 'RUNNING', 'SUCCEEDED', 'FAILED', 'CANCELLED'. |
| `page_size` | integer | No | Number of structure runs to return per page. Must be >= 1. |
| `structure_id` | string | Yes | Unique identifier of the structure to list runs for. Use the Get Structures Dashboard or related actions to find available structure IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Structures

**Slug:** `GRIPTAPE_LIST_STRUCTURES`

Tool to list all structures in Griptape Cloud. Use to retrieve available structures with optional pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `page_size` | integer | No | Number of structures to return per page. Must be >= 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Thread Messages

**Slug:** `GRIPTAPE_LIST_THREAD_MESSAGES`

Tool to list all messages in a specific thread. Use when you need to retrieve the conversation history or all messages from a thread in Griptape Cloud. Supports pagination for threads with many messages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `page_size` | integer | No | Number of messages per page. Must be >= 1. |
| `thread_id` | string | Yes | The unique identifier (UUID) of the thread to retrieve messages from. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Threads

**Slug:** `GRIPTAPE_LIST_THREADS`

Tool to list all threads. Use to retrieve available conversation threads in Griptape Cloud with optional filters and pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `alias` | string | No | Filter threads by exact alias match. |
| `page_size` | integer | No | Number of threads to return per page. Must be >= 1. |
| `created_by` | string | No | Filter threads by creator user ID. |
| `starts_with` | string | No | Filter threads whose alias starts with this string prefix. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tool Deployments

**Slug:** `GRIPTAPE_LIST_TOOL_DEPLOYMENTS`

Tool to list all deployments for a specific tool. Use when you need to retrieve deployment history and status for a tool in Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `tool_id` | string | Yes | Unique identifier (UUID) of the tool to list deployments for. |
| `page_size` | integer | No | Number of deployments to return per page. Must be >= 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tool Runs

**Slug:** `GRIPTAPE_LIST_TOOL_RUNS`

Tool to list all runs for a specific tool with optional pagination and status filtering. Use when you need to retrieve historical execution runs for a tool.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be >= 1. |
| `status` | array | No | List of run statuses to filter by. Common statuses include: 'QUEUED', 'RUNNING', 'SUCCEEDED', 'FAILED', 'CANCELLED'. |
| `tool_id` | string | Yes | Unique identifier of the tool to list runs for. Use the List Tools or related actions to find available tool IDs. |
| `page_size` | integer | No | Number of tool runs to return per page. Must be >= 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Users

**Slug:** `GRIPTAPE_LIST_USERS`

Tool to list all users in Griptape Cloud. Use after authenticating to retrieve available users.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query knowledge base

**Slug:** `GRIPTAPE_QUERY_KNOWLEDGE_BASE`

Performs semantic search against a Griptape Cloud knowledge base using natural language. Returns matching entries with similarity scores and metadata. Use this when you need to retrieve raw vector search results from a knowledge base. For a higher-level natural language answer, use the Search Knowledge Base action instead.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Natural-language query text to search for in the knowledge base |
| `query_args` | object | No | Additional options for querying the knowledge base |
| `knowledge_base_id` | string | Yes | UUID of the Knowledge Base to query. Can be found in the Griptape Cloud console. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query Retriever

**Slug:** `GRIPTAPE_QUERY_RETRIEVER`

Tool to query a retriever in Griptape Cloud with a natural-language query. Use when you need to retrieve information using a configured retriever, which may include reranking and multi-knowledge-base search capabilities.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Natural-language query text to search for using the retriever. Must not be empty. |
| `retriever_id` | string | Yes | The unique identifier (UUID) of the retriever to query. This is a UUID v4 format identifier. |
| `retriever_components_query_args` | object | No | Optional query arguments for retriever components to customize the retrieval behavior. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Ruleset Creation

**Slug:** `GRIPTAPE_RULESET_CREATION`

Creates a new ruleset in Griptape Cloud. Rulesets are containers for rules that define behavioral guidelines for AI assistants. After creation, you can add rules to the ruleset and attach it to assistants to control their behavior.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable name for the new ruleset. This name identifies the ruleset in the Griptape Cloud. |
| `metadata` | object | No | Optional key-value pairs for storing custom attributes with the ruleset (e.g., version, category, priority) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Knowledge Base

**Slug:** `GRIPTAPE_SEARCH_KNOWLEDGE_BASE`

Searches a Griptape Cloud Knowledge Base with a natural-language query and returns a synthesized answer. Use this tool when you need to: - Retrieve information from a specific knowledge base using natural language - Get AI-synthesized answers based on documents stored in a knowledge base - Query company documentation, FAQs, or other indexed content Prerequisites: You need a valid Knowledge Base ID, which can be found in the Griptape Cloud console. Example queries: - "What is the refund policy?" - "How do I reset my password?" - "What are the supported file formats?"

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | A natural-language question to search against the Knowledge Base. Must not be empty. |
| `knowledge_base_id` | string | Yes | The unique identifier (UUID) of the Knowledge Base to search. Can be found in the Griptape Cloud console Config tab. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tool

**Slug:** `GRIPTAPE_TOOL_CREATION`

Create a new tool resource in Griptape Cloud. Use this to register a new tool that can be configured and deployed later. The tool code can be added via the Griptape Cloud console after creation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique name for the tool (1-200 characters). |
| `description` | string | No | Description of the tool's purpose (1-200 characters). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tool Deployment Status

**Slug:** `GRIPTAPE_TOOL_DEPLOYMENT_STATUS_RETRIEVAL`

Tool to retrieve status of a specific tool deployment. Use after creating a deployment to poll its progress.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tool_id` | string | Yes | Unique identifier (UUID) of the tool whose deployment status is being fetched. Obtain this from the List Tools action. |
| `deployment_id` | string | Yes | Unique identifier (UUID) of the specific deployment to query. Obtain this from the tool's deployment history. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tools

**Slug:** `GRIPTAPE_TOOL_LISTING`

Tool to list all tools. Use when you need to discover available tools and their IDs in Griptape Cloud.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Assistant

**Slug:** `GRIPTAPE_UPDATE_ASSISTANT`

Tool to update an existing assistant's configuration. Use when you need to modify an assistant's name, description, model, or attached resources like knowledge bases, rulesets, structures, or tools.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New name for the assistant. Must be 1-200 characters if provided. |
| `input` | string | No | Updated default input specification or prompt template for the assistant. |
| `model` | string | No | Updated LLM model identifier to use. |
| `tool_ids` | array | No | Updated list of tool UUIDs to enable for this assistant. |
| `description` | string | No | Updated description of the assistant's purpose. Max 200 characters if provided. |
| `ruleset_ids` | array | No | Updated list of ruleset UUIDs to apply to this assistant for behavior constraints. |
| `assistant_id` | string | Yes | Unique identifier (UUID) of the assistant to update. |
| `structure_ids` | array | No | Updated list of structure UUIDs for execution workflows. |
| `knowledge_base_ids` | array | No | Updated list of knowledge base UUIDs to connect to this assistant for RAG capabilities. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Bucket

**Slug:** `GRIPTAPE_UPDATE_BUCKET`

Tool to update a bucket's properties by its ID. Use when you need to modify bucket details such as the name in Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New name for the bucket. Must be between 1 and 256 characters. |
| `bucket_id` | string | Yes | The unique identifier (UUID) of the bucket to update. This is a UUID v4 format identifier (e.g., '599a4d24-cda7-4ccf-9b72-6484294c6c87'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Data Connector

**Slug:** `GRIPTAPE_UPDATE_DATA_CONNECTOR`

Tool to update a data connector's configuration in Griptape Cloud. Use when you need to modify an existing data connector's name, description, schedule, or configuration settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Updated name for the data connector. Must be 1-200 characters. |
| `config` | object | No | Updated configuration for the data connector. Structure varies by connector type (e.g., {'confluence': {...}}, {'google_drive': {...}}, {'webscraper': {...}}, {'structure': {...}}, {'s3': {...}}, {'data_lake': {...}}). |
| `description` | string | No | Updated description of the data connector's purpose. Must be 1-200 characters. |
| `data_connector_id` | string | Yes | The unique identifier (UUID) of the data connector to update. Must be a valid UUID v4 format. |
| `schedule_expression` | string | No | Updated cron or schedule expression for automated data syncing. Must be 1-200 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Function

**Slug:** `GRIPTAPE_UPDATE_FUNCTION`

Tool to update an existing function's configuration. Use when you need to modify a function's name, description, code configuration, environment variables, or configuration file path.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | object | No | Schema representing the code configuration for a function. |
| `name` | string | No | Updated name for the function. Must be 1-200 characters if provided. |
| `env_vars` | array | No | Updated list of environment variables for the function. |
| `description` | string | No | Updated description of the function. Must be 1-200 characters if provided. |
| `function_id` | string | Yes | Unique identifier (UUID) of the function to update. |
| `function_config_file` | string | No | Updated path to the function configuration file. Must be 1-200 characters if provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Integration

**Slug:** `GRIPTAPE_UPDATE_INTEGRATION`

Tool to update an existing integration's configuration. Use when you need to modify an integration's name, description, type, configuration, or associated resources like assistants and structures.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New name for the integration. Must be 1-200 characters if provided. |
| `type` | string | No | Updated type of the integration. Must be one of: slack, github_app, or webhook. |
| `config` | object | No | Updated configuration settings for the integration. Structure varies based on integration type (slack, github_app, or webhook). |
| `description` | string | No | Updated description of the integration. Must be 1-200 characters if provided. |
| `assistant_ids` | array | No | Updated list of assistant IDs (UUIDs) to associate with this integration. |
| `structure_ids` | array | No | Updated list of structure IDs (UUIDs) to associate with this integration. |
| `integration_id` | string | Yes | Unique identifier (UUID) of the integration to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Knowledge Base

**Slug:** `GRIPTAPE_UPDATE_KNOWLEDGE_BASE`

Tool to update a knowledge base's configuration in Griptape Cloud. Use when you need to modify a knowledge base's type, config, description, name, embedding model, or other properties.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New name for the knowledge base. Must be 1-200 characters if provided. |
| `type` | string | No | Type of the knowledge base (e.g., 'gtc_pg_vector', 'pg_vector', 'gtc_hybrid_sql_pg_vector'). Must be 1-200 characters. |
| `config` | object | No | Configuration for the knowledge base vector store. |
| `transforms` | array | No | List of transformations to apply to the knowledge base data. |
| `asset_paths` | array | No | Updated list of asset paths to associate with this knowledge base. |
| `description` | string | No | Updated description of the knowledge base's purpose. Must be 1-200 characters if provided. |
| `embedding_model` | string | No | The embedding model to use. Valid values: 'text-embedding-ada-002', 'text-embedding-3-small'. |
| `knowledge_base_id` | string | Yes | The unique identifier (UUID) of the knowledge base to update. Must be a valid UUID v4 format. |
| `schedule_expression` | string | No | Cron or schedule expression for automated knowledge base updates. Must be 1-200 characters. |
| `use_default_embedding_model` | boolean | No | Whether to use the default embedding model for this knowledge base. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Library

**Slug:** `GRIPTAPE_UPDATE_LIBRARY`

Tool to update an existing library's configuration in Griptape Cloud. Use when you need to modify a library's name, description, data connectors, or knowledge base configurations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Updated name for the library. Must be between 1 and 64 characters. |
| `library_id` | string | Yes | The unique identifier (UUID) of the library to update. |
| `description` | string | No | Updated description of the library's purpose. Must be between 1 and 256 characters if provided. |
| `data_connector_ids` | array | Yes | Updated list of data connector UUIDs to associate with this library. Can be an empty list. |
| `knowledge_base_configs` | array | Yes | Updated list of knowledge base configuration objects. Each config must specify one of: pg_vector, gtc_pg_vector, gtc_hybrid_sql_pg_vector, or pgai_knowledge_base. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Message

**Slug:** `GRIPTAPE_UPDATE_MESSAGE`

Tool to update a message's input, output, and metadata by its ID. Use when you need to modify message content or associated metadata in Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `input` | string | No | Updated input content of the message. The text or prompt that was sent to the assistant. |
| `output` | string | No | Updated output content or response of the message. The assistant's response. |
| `metadata` | object | No | Updated metadata associated with the message. Can contain any additional key-value pairs. |
| `message_id` | string | Yes | The unique identifier (UUID) of the message to update. UUID v4 format (e.g., '4fe85c9a-c3e9-4a10-8985-705ba0694b62'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Model Configuration

**Slug:** `GRIPTAPE_UPDATE_MODEL`

Tool to update a model configuration's properties by its ID. Use when you need to modify model details such as name, description, type, authentication settings, or activation status in Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `active` | boolean | No | Whether the model configuration should be active. Set to true to enable, false to disable. |
| `kwargs` | object | No | Additional keyword arguments for the model configuration. Use for provider-specific settings. |
| `model_name` | string | No | Updated name of the model (e.g., 'gpt-4', 'claude-3-opus'). Must be 1-1000 characters. |
| `model_type` | string ("chat" | "embedding" | "rerank" | "image_generation" | "unknown") | No | Enum representing the type of model. |
| `description` | string | No | Updated description of the model configuration's purpose or characteristics. |
| `auth_config_id` | string | No | UUID of the authentication configuration to use for this model. Must be a valid UUID v4 format. This links the model to specific API credentials. |
| `model_config_id` | string | Yes | The unique identifier (UUID) of the model configuration to update. This is a UUID v4 format identifier. Obtain this from model creation or listing responses. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Model Auth Config

**Slug:** `GRIPTAPE_UPDATE_MODEL_AUTH_CONFIG`

Tool to update an existing model auth config's properties. Use when you need to modify a model authentication configuration's name, API key secret, base URL, or additional kwargs in Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New name for the model auth config. Must be 1-200 characters if provided. |
| `kwargs` | object | No | Additional keyword arguments for the auth config. |
| `base_url` | string | No | Base URL for the model API endpoint. |
| `auth_config_id` | string | Yes | Unique identifier (UUID) of the model auth config to update. |
| `api_key_secret_id` | string | No | UUID of the API key secret to associate with this auth config. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Organization

**Slug:** `GRIPTAPE_UPDATE_ORGANIZATION`

Tool to update an organization's properties by its ID. Use when you need to modify organization details such as the name or model configuration settings in Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New name for the organization. Must be between 1 and 200 characters if provided. |
| `model_config` | object | No | Model configuration for the organization. |
| `organization_id` | string | Yes | The unique identifier (UUID) of the organization to update. Must be a valid UUID v4 format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Retriever

**Slug:** `GRIPTAPE_UPDATE_RETRIEVER`

Tool to update an existing retriever's configuration in Griptape Cloud. Use when you need to modify a retriever's name, description, or associated retriever components.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Updated name for the retriever. Must be 1-64 characters. |
| `description` | string | No | Updated description of the retriever's purpose. Must be 1-256 characters. |
| `retriever_id` | string | Yes | The unique identifier (UUID) of the retriever to update. Must be a valid UUID v4 format. |
| `retriever_components` | array | No | Updated list of retriever component objects to create or update for this retriever. Each component must have 'name' and 'type' fields. |
| `retriever_component_ids` | array | No | Updated list of retriever component UUIDs to associate with this retriever. Each ID must be a valid UUID v4 format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Retriever Component

**Slug:** `GRIPTAPE_UPDATE_RETRIEVER_COMPONENT`

Tool to update a retriever component's configuration by its ID. Use when you need to modify properties such as name, description, type, or configuration of a retriever component in Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New name for the retriever component. Must be between 1 and 64 characters if provided. |
| `type` | string | Yes | Type of the retriever component. This is a required field that specifies the component type. |
| `config` | object | Yes | Configuration settings for the retriever component. This is a required field containing the component's configuration. |
| `description` | string | No | Updated description of the retriever component's purpose or functionality. Must be between 1 and 256 characters if provided. |
| `retriever_component_id` | string | Yes | The unique identifier (UUID) of the retriever component to update. This is a UUID v4 format identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Rule

**Slug:** `GRIPTAPE_UPDATE_RULE`

Tool to update an existing rule's configuration. Use when you need to modify a rule's name, content, or metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New name for the rule. Must be 1-200 characters if provided. |
| `rule` | string | No | Updated rule content or definition text. Must be 1-2000 characters if provided. |
| `rule_id` | string | Yes | Unique identifier (UUID) of the rule to update. The rule must exist in Griptape Cloud and belong to your organization. |
| `metadata` | object | No | Updated key-value metadata to associate with the rule. Can contain arbitrary data for organizational purposes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Ruleset

**Slug:** `GRIPTAPE_UPDATE_RULESET`

Tool to update an existing ruleset's configuration. Use when you need to modify a ruleset's name, description, alias, rules, or metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Updated name for the ruleset. Must be 1-200 characters if provided. |
| `alias` | string | No | Updated alias identifier for the ruleset. Must be 1-200 characters if provided. |
| `metadata` | object | No | Updated key-value metadata pairs for storing custom attributes with the ruleset. |
| `rule_ids` | array | No | Updated list of rule UUIDs to associate with this ruleset. |
| `ruleset_id` | string | Yes | Unique identifier (UUID) of the ruleset to update. |
| `description` | string | No | Updated description of the ruleset. Must be 1-200 characters if provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Secret

**Slug:** `GRIPTAPE_UPDATE_SECRET`

Tool to update a secret's properties by its ID. Use when you need to modify secret details such as the name or value in Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New name for the secret. Must be between 1 and 200 characters if provided. |
| `value` | string | No | New value for the secret. Must be between 1 and 200 characters if provided. |
| `secret_id` | string | Yes | The unique identifier (UUID) of the secret to update. Must be a valid UUID v4 format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Structure

**Slug:** `GRIPTAPE_UPDATE_STRUCTURE`

Tool to update an existing structure's configuration. Use when you need to modify a structure's name, description, code configuration, environment variables, or webhook settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | object | No | Schema representing the code configuration for a structure. |
| `name` | string | No | New name for the structure. Must be 1-200 characters if provided. |
| `env_vars` | array | No | Updated list of environment variables configured for the structure. |
| `description` | string | No | Updated description of the structure's purpose. Must be 1-200 characters if provided. |
| `structure_id` | string | Yes | Unique identifier (UUID) of the structure to update. |
| `webhook_enabled` | boolean | No | Whether to enable or disable webhooks for this structure. |
| `structure_config_file` | string | No | Updated path to the structure configuration file. Must be 1-200 characters if provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Thread

**Slug:** `GRIPTAPE_UPDATE_THREAD`

Tool to update an existing thread's configuration. Use when you need to modify a thread's name, alias, metadata, or messages in Griptape Cloud.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New name for the thread. Must be 1-200 characters if provided. |
| `alias` | string | No | New alias for the thread. Must be 1-200 characters if provided. |
| `messages` | array | No | List of messages to add or update in the thread. Each message requires 'input' and 'output' fields. |
| `metadata` | object | No | Additional metadata to associate with the thread. |
| `thread_id` | string | Yes | Unique identifier (UUID) of the thread to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Tool

**Slug:** `GRIPTAPE_UPDATE_TOOL`

Tool to update an existing tool's configuration. Use when you need to modify a tool's name, description, code configuration, environment variables, or configuration file path.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | object | No | Schema representing the code configuration for a tool. |
| `name` | string | No | Updated name for the tool. Must be 1-200 characters if provided. |
| `tool_id` | string | Yes | Unique identifier (UUID) of the tool to update. |
| `env_vars` | array | No | Updated list of environment variables for the tool. |
| `description` | string | No | Updated description of the tool. Must be 1-200 characters if provided. |
| `tool_config_file` | string | No | Updated path to the tool configuration file. Must be 1-200 characters if provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |