Skip to main content
Griptape logo
  • Category: artificial intelligence
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 143
  • Triggers: 0
  • Slug: GRIPTAPE
  • Version: 20261101_00

Tools

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

Input Parameters

string
required
Name for the assistant. Must be 1-200 characters.
string
Default input specification or prompt template for the assistant.
string
LLM model identifier to use. If omitted, uses the account default model.
array
List of tool UUIDs to enable for this assistant.
string
Brief description of the assistant’s purpose. Max 200 characters.
array
List of ruleset UUIDs to apply to this assistant for behavior constraints.
array
List of retriever UUIDs to attach for document retrieval.
array
List of structure UUIDs for execution workflows.
array
List of knowledge base UUIDs to connect to this assistant for RAG capabilities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_ASSISTANT_LISTINGTool to list all assistants. Use after authenticating with Griptape Cloud to retrieve available assistants. Supports optional pagination.

Input Parameters

integer
Maximum number of assistants to return. Must be >= 1.
integer
Number of assistants to skip for pagination. Must be >= 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_ASSISTANT_RUN_CANCELLATIONTool to cancel an ongoing assistant run. Use when you need to stop a run prematurely after confirming the run ID is valid.

Input Parameters

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_ASSISTANT_RUN_CREATIONCreates 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

array
List of string arguments to pass into the run. These are additional input artifacts for the assistant.
string
The input message or prompt to send to the assistant for this run. This is the primary way to interact with the assistant.
boolean
Whether to enable streaming for run events. When True, use the assistant run events stream action to receive real-time updates.
array
List of tool IDs to enable for this run, overriding the assistant’s default tools.
string
The thread ID to associate with this run for maintaining conversation context across multiple runs.
array
List of ruleset IDs to apply for this run, overriding the assistant’s default rulesets.
string
required
The unique identifier (UUID) of the assistant to run. Obtain this from the assistant listing action.
array
List of structure IDs to use for the run, overriding the assistant’s default structures.
array
List of knowledge base IDs to query during the run, overriding the assistant’s default knowledge bases.
array
Additional tool IDs to include alongside the assistant’s default tools.
array
Additional ruleset IDs to include alongside the assistant’s default rulesets.
array
Additional structure IDs to include alongside the assistant’s default structures.
array
Additional knowledge base IDs to include alongside the assistant’s default knowledge bases.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_ASSISTANT_RUN_ERROR_DETAILSFetch error details for a specific assistant run to help investigate a failed run. If no error details are found or returned, the result indicates that instead.

Input Parameters

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_ASSISTANT_RUN_LISTINGList runs for a given assistant, with optional pagination. A 404 response is returned as an empty runs list.

Input Parameters

integer
Maximum number of runs to return, must be >= 1.
integer
Number of runs to skip before returning results, must be >= 0.
string
required
UUID of the assistant to list runs for. Use the List Assistants action to find available assistant IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_ASSISTANT_RUN_LOGS_RETRIEVALRetrieve execution events for a Griptape Cloud assistant run to inspect its activity, intermediate outputs, and token usage. The results may include structure and task lifecycle events, prompt events, and text chunks.

Input Parameters

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_ASSISTANT_RUN_RETRIEVALTool to retrieve an assistant run’s status and details. Use when you need current status and metadata for a specific assistant run.

Input Parameters

string
required
The unique identifier (UUID) of the assistant run to retrieve. Obtain this from the assistant run creation response or listing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_ASSISTANT_RUN_RETRYRetry a failed Griptape assistant run by its run ID. The result provides run details for checking its status.

Input Parameters

string
required
Unique identifier (UUID) of the assistant run to retry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_CANCEL_DATA_JOBTool 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

string
required
The unique identifier (UUID) of the data job to cancel. Must be in UUID format (e.g., ‘107e5aaf-61b9-4925-8f0d-f65312db31af’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_CREATE_BUCKETTool to create a new bucket in Griptape Cloud. Use when you need to create storage buckets for organizing assets and data.

Input Parameters

string
required
Name for the new bucket. Must be between 1 and 256 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_CREATE_BUCKET_ASSETTool 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

string
required
The name of the asset to create. Must be between 1 and 256 characters.
string
required
The unique identifier (UUID) of the bucket to create the asset in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_CREATE_DATA_CONNECTORTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_CREATE_DATA_CONNECTOR_JOBTool 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

string
required
The unique identifier (UUID) of the data connector to create a job for. Must be a valid UUID v4 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_CREATE_EXPORT_JOBTool to create a new export job in Griptape Cloud. Use when you need to initiate an export operation with custom data.

Input Parameters

object
Optional metadata object with additional properties describing the export job.
object
required
Flexible JSON object containing the data to be exported. Can contain any valid JSON structure with no strict schema constraints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_CREATE_FUNCTIONTool 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

string
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.
string
required
Name for the function. Must be 1-200 characters.
array
List of environment variables for the function.
string
Brief description of the function’s purpose. Max 200 characters.
string
Path to the function configuration file (1-200 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_CREATE_FUNCTION_DEPLOYMENTTool 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

boolean
If true, forces deployment even if another deployment is in progress. Use with caution.
object
required
Source code configuration specifying where to pull the code from (currently supports GitHub).
string
required
Unique identifier (UUID) of the function to create a deployment for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_CREATE_IMPORT_JOBTool 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

object
Additional key-value metadata for the import job. Can contain arbitrary information relevant to the import operation.
string
required
Type of import operation to perform. Required field that specifies the kind of data being imported.
string
Suffix to append to imported resources. Useful for versioning or distinguishing multiple imports.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_CREATE_INTEGRATIONTool 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

string
required
Name for the integration. Must be 1-200 characters.
string ("slack" | "github_app" | "webhook")
required
Type of integration to create (slack, github_app, or webhook).
string
required
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’: {}}.
string
Brief description of the integration’s purpose. Max 200 characters.
array
List of assistant UUIDs to associate with this integration.
array
List of structure UUIDs to associate with this integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_CREATE_KNOWLEDGE_BASETool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_CREATE_KNOWLEDGE_BASE_JOBTool 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

string
required
The unique identifier (UUID) of the knowledge base to create a job for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_CREATE_LIBRARYTool 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

string
required
Name for the library. Must be 1-64 characters.
string
Brief description of the library’s purpose. Max 256 characters.
array
required
List of data connector UUIDs to include in this library. Data connectors define data sources to ingest.
array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_CREATE_MODELTool 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

boolean
Whether the model configuration should be active. If not specified, defaults to true.
object
Additional keyword arguments for the model configuration (e.g., temperature, max_tokens).
string
required
Name of the model to configure (e.g., ‘gpt-4’, ‘claude-3-opus’). Must be 1-1000 characters.
string ("chat" | "embedding" | "rerank" | "image_generation" | "unknown")
required
Type of the model - determines how it will be used in Griptape Cloud.
string
Brief description of the model configuration and its intended use case.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_CREATE_MODEL_AUTH_CONFIGTool 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

string
required
Name of the model auth config (1-200 characters).
string
required
Base URL for the model API endpoint.
string
required
UUID of the API key secret to use for authentication. Must be a valid UUID v4 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_CREATE_ORGANIZATION_API_KEYTool 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

string
required
Name of the API key. Must be between 1 and 200 characters.
string
required
The unique identifier (UUID) of the organization to create the API key for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_CREATE_RETRIEVERTool 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

string
required
Name for the retriever. Must be 1-64 characters.
string
Description of the retriever’s purpose. Must be 1-256 characters if provided.
array
List of new retriever component objects to create for this retriever. Each component must have ‘name’ and ‘type’ fields.
array
List of existing retriever component UUIDs to associate with this retriever. Each ID must be a valid UUID v4 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_CREATE_RULETool to create a new rule in Griptape Cloud. Use when you need to define behavioral guidelines or constraints for AI assistants.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_CREATE_SECRETTool to create a new secret in Griptape Cloud. Use when you need to store sensitive information like API keys, passwords, or tokens.

Input Parameters

string
required
Name of the secret. Must be between 1 and 200 characters.
string
required
Value of the secret. Must be between 1 and 200 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_CREATE_STRUCTURETool 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

string
Code source configuration. Can be GitHub, data lake, or default. Specify exactly one of the source types.
string
required
Name for the structure. Must be 1-200 characters.
array
List of environment variables to configure for the structure.
string
Brief description of the structure’s purpose. Max 200 characters.
boolean
Whether to enable webhook functionality for this structure.
string
Path to the structure configuration file. Max 200 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_CREATE_STRUCTURE_DEPLOYMENTTool 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

boolean
Force deployment even if a deployment is already in progress. Use with caution.
object
required
Code source configuration specifying where to deploy the structure code from.
string
required
Unique identifier (UUID) of the structure to deploy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_CREATE_THREADTool 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

string
required
Name for the thread. Must be 1-200 characters.
string
Alias for the thread. Must be 1-200 characters if provided.
array
Optional list of messages to initialize the thread with. Each message requires both input and output.
object
Optional metadata to associate with the thread. Can contain arbitrary key-value pairs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_CREATE_THREAD_MESSAGETool 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

string
required
The input content of the message.
string
required
The output content or response of the message.
object
Additional metadata to associate with the message.
string
required
The unique identifier (UUID) of the thread to create the message in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_CREATE_TOOL_DEPLOYMENTCreate 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

boolean
Whether to force deployment even if there are no code changes. Set to true to redeploy with the same code.
string
required
Unique identifier (UUID) of the tool to deploy. Obtain this from the List Tools or Create Tool action.
object
required
Source code configuration specifying the GitHub repository to deploy from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_DELETE_API_KEYTool to delete an API key by ID. Use when you need to permanently remove an API key from Griptape Cloud.

Input Parameters

string
required
Unique identifier (UUID) of the API key to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_DELETE_ASSISTANTTool to delete an assistant by ID. Use when you need to permanently remove an assistant from Griptape Cloud.

Input Parameters

string
required
Unique identifier (UUID) of the assistant to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_DELETE_BUCKETTool to delete a bucket by ID. Use when you need to remove a specific bucket from Griptape Cloud.

Input Parameters

string
required
The unique identifier (UUID) of the bucket to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_DELETE_BUCKET_ASSETTool 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

string
required
The name of the asset to delete from the bucket.
string
required
The unique identifier (UUID) of the bucket containing the asset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_DELETE_DATA_CONNECTORTool to delete a data connector. Use when you need to permanently remove a data connector from Griptape Cloud.

Input Parameters

string
required
The unique identifier (UUID) of the data connector to delete. This operation is irreversible and will permanently remove the data connector.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_DELETE_FUNCTIONTool to delete a function from Griptape Cloud. Use when you need to permanently remove a function by its ID.

Input Parameters

string
required
Unique identifier (UUID) of the function to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_DELETE_INTEGRATIONTool to delete an integration by ID. Use when you need to permanently remove an integration from Griptape Cloud.

Input Parameters

string
required
The unique identifier (UUID) of the integration to delete. This will permanently remove the integration from Griptape Cloud.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_DELETE_KNOWLEDGE_BASETool 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

string
required
The unique identifier (UUID) of the Knowledge Base to delete. Can be found in the Griptape Cloud console Config tab.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_DELETE_LIBRARYTool to delete a library from Griptape Cloud. Use when you need to permanently remove a library resource.

Input Parameters

string
required
Unique identifier (UUID) of the library to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_DELETE_MESSAGETool to delete a message by its ID. Use when you need to remove a specific message from Griptape Cloud.

Input Parameters

string
required
The unique identifier (UUID) of the message to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_DELETE_MODELTool to delete a model configuration from Griptape Cloud. Use when you need to permanently remove a model configuration.

Input Parameters

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_DELETE_MODEL_AUTH_CONFIGTool to delete a model auth config by ID. Use when you need to permanently remove a model authentication configuration from Griptape Cloud.

Input Parameters

string
required
Unique identifier (UUID) of the model auth config to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_DELETE_RULETool to delete a rule by its ID. Use when you need to permanently remove a rule from Griptape Cloud.

Input Parameters

string
required
Unique identifier (UUID) of the rule to delete. The rule must exist in the Griptape Cloud and belong to your organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_DELETE_RULESETTool 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

string
required
Unique identifier (UUID) of the ruleset to delete. This permanently removes the ruleset and its associated rules from Griptape Cloud.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_DELETE_SECRETTool to delete a secret from Griptape Cloud. Use when you need to permanently remove a secret by its ID.

Input Parameters

string
required
The unique identifier (UUID) of the secret to delete. This operation is irreversible.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_DELETE_STRUCTURETool 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

string
required
The unique identifier (UUID) of the structure to delete. This action is irreversible and will permanently remove the structure from your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_DELETE_THREADTool 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

string
required
The unique identifier (UUID) of the thread to delete. Once deleted, the thread and all its associated messages will be permanently removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_DELETE_TOOLTool to delete a tool from Griptape Cloud. Use when you need to permanently remove a tool resource by its ID.

Input Parameters

string
required
Unique identifier (UUID) of the tool to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_API_KEYTool to retrieve an API key’s details. Use when you need to get information about a specific API key by its ID.

Input Parameters

string
required
The unique identifier (UUID) of the API key to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_ASSISTANTTool 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

string
required
The unique identifier (UUID) of the assistant to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_BILLING_MANAGEMENT_URLTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_BUCKETTool 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

string
required
The unique identifier (UUID) of the bucket to retrieve. This is a UUID v4 format identifier (e.g., ‘599a4d24-cda7-4ccf-9b72-6484294c6c87’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_BUCKET_ASSETTool 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

string
required
The name of the asset to retrieve from the bucket.
string
required
The unique identifier (UUID) of the bucket containing the asset.
boolean
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_BUCKET_ASSET_URLTool 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

string
required
The name or path of the asset in the bucket for which to generate a signed URL.
string
required
The unique identifier (UUID) of the bucket containing the asset.
string ("PUT" | "GET")
Enum for asset URL operation types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_CONFIGTool to retrieve Griptape Cloud configuration. Use when you need to access data lake settings or Google Drive connector configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_CREDITS_BALANCETool to retrieve the current credits balance. Use when you need to check available credits for billing or usage tracking.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_DATA_CONNECTORTool 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

string
required
The unique identifier (UUID) of the data connector to retrieve. Must be a valid UUID v4 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_DATA_JOBTool 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

string
required
The unique identifier (UUID) of the data job to retrieve. Must be in UUID format (e.g., ‘85e0625a-18e4-410a-bf28-b8cb745f5141’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_EXPORT_JOBTool to retrieve an export job by ID. Use when you need to check the status or details of an export operation.

Input Parameters

string
required
Unique identifier (UUID) of the export job to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_FUNCTIONTool 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

string
required
The unique identifier (UUID) of the function to retrieve. Obtain this from function creation or listing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_IMPORT_JOBTool 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

string
required
The unique identifier (UUID) of the import job to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_INTEGRATIONTool 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

string
required
The unique identifier (UUID) of the integration to retrieve. This is a UUID v4 format identifier (e.g., ‘897003ec-49cd-4e5f-9ace-c5c721ce2222’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_KNOWLEDGE_BASETool 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

string
required
The unique identifier (UUID) of the knowledge base to retrieve. Must be a valid UUID v4 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_KNOWLEDGE_BASE_JOBTool 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

string
required
The unique identifier (UUID) of the knowledge base job to retrieve. Must be in UUID format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_KNOWLEDGE_BASE_SEARCHTool 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

string
required
The unique identifier (UUID) of the knowledge base search to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_LIBRARYTool 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

string
required
The unique identifier (UUID) of the library to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_MESSAGETool to retrieve a specific message’s details by ID. Use when you need detailed information about a particular message from a thread.

Input Parameters

string
required
The unique identifier (UUID) of the message to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_MODELTool 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

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_MODEL_AUTH_CONFIGTool to retrieve a model auth config by ID. Use when you need to get configuration details for model authentication in Griptape Cloud.

Input Parameters

string
required
Unique identifier (UUID) of the model auth config to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_ORGANIZATIONTool 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

string
required
The unique identifier (UUID) of the organization to retrieve. Must be a valid UUID v4 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_RETRIEVERTool 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

string
required
The unique identifier (UUID) of the retriever to retrieve. This is a UUID v4 format identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_RETRIEVER_COMPONENTTool 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

string
required
The unique identifier (UUID) of the retriever component to retrieve. This is a UUID v4 format identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_RULETool 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

string
required
Unique identifier (UUID) of the rule to retrieve. The rule must exist in the Griptape Cloud and belong to your organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_RULESETRetrieve a Griptape Cloud ruleset by ID, including its name, associated rule IDs, metadata, and timestamps.

Input Parameters

string
required
Unique identifier (UUID) of the ruleset to retrieve. The ruleset must exist in Griptape Cloud and belong to your organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_RULESET_BY_ALIASRetrieve 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

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_SECRETTool 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

string
required
The unique identifier (UUID) of the secret to retrieve. Must be a valid UUID v4 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_STRUCTURETool 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

string
required
The unique identifier (UUID) of the structure to retrieve. Must be a valid UUID v4 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_STRUCTURES_DASHBOARDTool to retrieve dashboard metrics for structures. Use when you need analytics on deployments, runs, errors, durations, and token usage.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_THREADTool 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

string
required
The unique identifier (UUID) of the thread to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_TOOLRetrieve a specific tool’s details by ID, including its configuration, environment variables, and latest deployment ID.

Input Parameters

string
required
The unique identifier (UUID) of the tool to retrieve. Obtain this from tool creation or listing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_USAGETool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_GET_USERTool 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

string
required
The unique identifier (UUID) of the user to retrieve. Must be a valid UUID v4 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_ASSISTANT_RUN_EVENTSTool 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

integer
Maximum number of events to return, must be >= 1. Use this to control page size.
integer
Number of events to skip before returning results, must be >= 0. Use this with limit for pagination.
string
required
The unique identifier (UUID) of the assistant run to list events for. Obtain this from the assistant run creation response or listing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_BUCKET_ASSETSTool 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

integer
Page number for pagination, must be >= 1.
string
Filter assets by name prefix. Only assets whose names start with this string will be returned.
string
Filter assets by name postfix. Only assets whose names end with this string will be returned.
string
required
UUID of the bucket to list assets for. Use the List Buckets action to find available bucket IDs.
integer
Number of assets per page, must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_BUCKETSTool to list all buckets in Griptape Cloud. Use after authenticating to retrieve available buckets with pagination support.

Input Parameters

integer
Page number for pagination. Must be >= 1.
integer
Number of buckets to return per page. Must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_CONNECTIONSTool to list all connections. Use after authenticating with Griptape Cloud to retrieve available connections. Supports optional pagination and type filtering.

Input Parameters

integer
Page number for pagination. Must be >= 1.
string
Filter connections by type (e.g., ‘database’, ‘api’, ‘storage’).
integer
Number of connections to return per page. Must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_DATA_CONNECTORSTool to list all data connectors. Use when you need to discover available data connectors and their configurations in Griptape Cloud. Supports pagination.

Input Parameters

integer
Page number for pagination. Must be >= 1.
integer
Number of data connectors per page. Must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_EMBEDDING_DRIVERSDiscover embedding drivers and models by probing available endpoints. Results are normalized from driver or model listings and may include synthesized driver information.

Input Parameters

string
Optional endpoint path or alias to query for drivers. Examples: ‘embedding/drivers’, ‘embedding’, ‘models’, ‘info’, ‘/models’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_EXPORT_JOBSTool 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

integer
Page number for pagination. Must be >= 1.
array
List of statuses to filter by (e.g., [‘QUEUED’, ‘RUNNING’, ‘SUCCEEDED’, ‘FAILED’, ‘CANCELLED’]).
integer
Number of export jobs to return per page. Must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_FUNCTION_DEPLOYMENTSList deployments for a specific function in Griptape Cloud, including deployment history and status. Results are paginated.

Input Parameters

integer
Page number for pagination. Must be >= 1.
integer
Number of deployments to return per page. Must be >= 1.
string
required
Unique identifier (UUID) of the function to list deployments for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_FUNCTIONSTool to list all functions with optional pagination. Use when you need to discover available functions and their IDs in Griptape Cloud.

Input Parameters

integer
Page number for pagination. Must be >= 1.
integer
Number of functions per page. Must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_IMPORT_JOBSTool 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

integer
Page number for pagination. Must be >= 1.
array
List of statuses to filter import jobs by (e.g., [‘PENDING’, ‘COMPLETED’, ‘FAILED’]). If not provided, all import jobs are returned.
integer
Number of import jobs to return per page. Must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_INTEGRATIONSTool to list all integrations. Use when you need to discover available integrations in Griptape Cloud. Supports optional pagination.

Input Parameters

integer
Page number for pagination, must be >= 1.
integer
Number of integrations to return per page, must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_KNOWLEDGE_BASE_JOBSTool 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

integer
Page number for pagination. Must be >= 1.
array
List of statuses to filter knowledge base jobs by (e.g., [‘QUEUED’, ‘RUNNING’, ‘SUCCEEDED’, ‘FAILED’]). If not provided, all jobs are returned.
integer
Number of knowledge base jobs to return per page. Must be >= 1.
string
required
The unique identifier (UUID) of the knowledge base to list jobs for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_KNOWLEDGE_BASE_QUERIESTool 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

integer
Page number for pagination, must be >= 1.
integer
Number of queries per page, must be >= 1.
string
required
UUID of the Knowledge Base to list queries for. Can be found in the Griptape Cloud console.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_KNOWLEDGE_BASESTool to list all knowledge bases. Use to retrieve available knowledge bases in Griptape Cloud with optional pagination.

Input Parameters

integer
Page number for pagination. Must be >= 1.
integer
Number of knowledge bases to return per page. Must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_KNOWLEDGE_BASE_SEARCHESTool 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

integer
Page number for pagination. Must be >= 1.
integer
Number of searches to return per page. Must be >= 1.
string
required
The unique identifier (UUID) of the knowledge base to list searches for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_LIBRARIESTool to list all libraries in Griptape Cloud. Use after authenticating to retrieve available libraries with pagination support.

Input Parameters

integer
Page number for pagination. Must be >= 1.
integer
Number of libraries to return per page. Must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_MODEL_AUTH_CONFIGSLists model authentication configurations in Griptape Cloud, with optional pagination, to discover available configurations and their IDs.

Input Parameters

integer
Page number for pagination. Must be >= 1.
integer
Number of model auth configs per page. Must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_MODELSLists models in Griptape Cloud to discover available models and their configurations. Supports pagination and filtering by model type or default status.

Input Parameters

integer
Page number for pagination. Must be >= 1.
boolean
Filter to show only default models (true) or non-default models (false).
integer
Number of models per page. Must be >= 1.
string
Filter models by type (e.g., ‘prompt’, ‘embedding’, ‘image’, ‘text’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_ORGANIZATION_API_KEYSLists API keys for a specific Griptape Cloud organization, with optional pagination.

Input Parameters

integer
Page number for pagination. Must be >= 1.
integer
Number of API keys to return per page. Must be >= 1.
string
required
The unique identifier (UUID) of the organization to list API keys for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_ORGANIZATIONSTool to list all organizations in Griptape Cloud. Use after authenticating to retrieve available organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_RETRIEVER_COMPONENTSList retriever components in Griptape Cloud with pagination, including their names, types, and other details. Component configuration values are not retained in the returned configuration object.

Input Parameters

integer
Page number for pagination. Must be >= 1.
integer
Number of retriever components per page. Must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_RETRIEVERSTool to list all retrievers in Griptape Cloud. Use to retrieve available retrievers with optional pagination support.

Input Parameters

integer
Page number for pagination. Must be >= 1.
integer
Number of retrievers to return per page. Must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_RULESTool 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

integer
Page number for pagination. Must be >= 1.
integer
Number of rules to return per page. Must be >= 1.
string
Filter rules by ruleset ID. Only returns rules belonging to the specified ruleset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_SECRETSTool to list all secrets in Griptape Cloud. Use to retrieve available secrets with optional pagination.

Input Parameters

integer
Page number for pagination. Must be >= 1.
integer
Number of secrets to return per page. Must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_STRUCTURE_DEPLOYMENTSTool 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

integer
Page number for pagination. Must be >= 1.
array
Comma-separated list of deployment statuses to filter by. Possible values: ‘QUEUED’, ‘DEPLOYING’, ‘SUCCEEDED’, ‘FAILED’, ‘ERROR’.
integer
Number of deployments to return per page. Must be >= 1.
string
required
Unique identifier (UUID) of the structure to list deployments for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_STRUCTURE_RUNSTool 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

integer
Page number for pagination. Must be >= 1.
array
List of run statuses to filter by. Common statuses include: ‘QUEUED’, ‘RUNNING’, ‘SUCCEEDED’, ‘FAILED’, ‘CANCELLED’.
integer
Number of structure runs to return per page. Must be >= 1.
string
required
Unique identifier of the structure to list runs for. Use the Get Structures Dashboard or related actions to find available structure IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_STRUCTURESTool to list all structures in Griptape Cloud. Use to retrieve available structures with optional pagination support.

Input Parameters

integer
Page number for pagination. Must be >= 1.
integer
Number of structures to return per page. Must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_THREAD_MESSAGESTool 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

integer
Page number for pagination. Must be >= 1.
integer
Number of messages per page. Must be >= 1.
string
required
The unique identifier (UUID) of the thread to retrieve messages from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_THREADSTool to list all threads. Use to retrieve available conversation threads in Griptape Cloud with optional filters and pagination.

Input Parameters

integer
Page number for pagination. Must be >= 1.
string
Filter threads by exact alias match.
integer
Number of threads to return per page. Must be >= 1.
string
Filter threads by creator user ID.
string
Filter threads whose alias starts with this string prefix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_TOOL_DEPLOYMENTSList deployments for a specific tool to retrieve deployment history and status. Results are paginated.

Input Parameters

integer
Page number for pagination. Must be >= 1.
string
required
Unique identifier (UUID) of the tool to list deployments for.
integer
Number of deployments to return per page. Must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_TOOL_RUNSTool 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

integer
Page number for pagination. Must be >= 1.
array
List of run statuses to filter by. Common statuses include: ‘QUEUED’, ‘RUNNING’, ‘SUCCEEDED’, ‘FAILED’, ‘CANCELLED’.
string
required
Unique identifier of the tool to list runs for. Use the List Tools or related actions to find available tool IDs.
integer
Number of tool runs to return per page. Must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_LIST_USERSTool to list all users in Griptape Cloud. Use after authenticating to retrieve available users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_QUERY_KNOWLEDGE_BASEPerforms semantic search against a Griptape Cloud knowledge base using natural language. Returns matching entries that may include similarity scores and metadata.

Input Parameters

string
required
Natural-language query text to search for in the knowledge base
object
Additional options for querying the knowledge base
string
required
UUID of the Knowledge Base to query. Can be found in the Griptape Cloud console.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_QUERY_RETRIEVERTool 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

string
required
Natural-language query text to search for using the retriever. Must not be empty.
string
required
The unique identifier (UUID) of the retriever to query. This is a UUID v4 format identifier.
object
Optional query arguments for retriever components to customize the retrieval behavior.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_RULESET_CREATIONCreates 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

string
required
Human-readable name for the new ruleset. This name identifies the ruleset in the Griptape Cloud.
object
Optional key-value pairs for storing custom attributes with the ruleset (e.g., version, category, priority)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_SEARCH_KNOWLEDGE_BASESearches 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

string
required
A natural-language question to search against the Knowledge Base. Must not be empty.
string
required
The unique identifier (UUID) of the Knowledge Base to search. Can be found in the Griptape Cloud console Config tab.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_TOOL_CREATIONCreate 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

string
required
Unique name for the tool (1-200 characters).
string
Description of the tool’s purpose (1-200 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_TOOL_DEPLOYMENT_STATUS_RETRIEVALTool to retrieve status of a specific tool deployment. Use after creating a deployment to poll its progress.

Input Parameters

string
required
Unique identifier (UUID) of the tool whose deployment status is being fetched. Obtain this from the List Tools action.
string
required
Unique identifier (UUID) of the specific deployment to query. Obtain this from the tool’s deployment history.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_TOOL_LISTINGTool to list all tools. Use when you need to discover available tools and their IDs in Griptape Cloud.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_UPDATE_ASSISTANTTool 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

string
New name for the assistant. Must be 1-200 characters if provided.
string
Updated default input specification or prompt template for the assistant.
string
Updated LLM model identifier to use.
array
Updated list of tool UUIDs to enable for this assistant.
string
Updated description of the assistant’s purpose. Max 200 characters if provided.
array
Updated list of ruleset UUIDs to apply to this assistant for behavior constraints.
string
required
Unique identifier (UUID) of the assistant to update.
array
Updated list of structure UUIDs for execution workflows.
array
Updated list of knowledge base UUIDs to connect to this assistant for RAG capabilities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_UPDATE_BUCKETUpdate the name of a Griptape Cloud bucket by its ID.

Input Parameters

string
New name for the bucket. Must be between 1 and 256 characters.
string
required
The unique identifier (UUID) of the bucket to update. This is a UUID v4 format identifier (e.g., ‘599a4d24-cda7-4ccf-9b72-6484294c6c87’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_UPDATE_DATA_CONNECTORTool 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

string
Updated name for the data connector. Must be 1-200 characters.
object
Updated configuration for the data connector. Structure varies by connector type (e.g., {‘confluence’: {…}}, {‘google_drive’: {…}}, {‘webscraper’: {…}}, {‘structure’: {…}}, {‘s3’: {…}}, {‘data_lake’: {…}}).
string
Updated description of the data connector’s purpose. Must be 1-200 characters.
string
required
The unique identifier (UUID) of the data connector to update. Must be a valid UUID v4 format.
string
Updated cron or schedule expression for automated data syncing. Must be 1-200 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_UPDATE_FUNCTIONTool 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

object
Schema representing the code configuration for a function.
string
Updated name for the function. Must be 1-200 characters if provided.
array
Updated list of environment variables for the function.
string
Updated description of the function. Must be 1-200 characters if provided.
string
required
Unique identifier (UUID) of the function to update.
string
Updated path to the function configuration file. Must be 1-200 characters if provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_UPDATE_INTEGRATIONTool 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

string
New name for the integration. Must be 1-200 characters if provided.
string
Updated type of the integration. Must be one of: slack, github_app, or webhook.
object
Updated configuration settings for the integration. Structure varies based on integration type (slack, github_app, or webhook).
string
Updated description of the integration. Must be 1-200 characters if provided.
array
Updated list of assistant IDs (UUIDs) to associate with this integration.
array
Updated list of structure IDs (UUIDs) to associate with this integration.
string
required
Unique identifier (UUID) of the integration to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_UPDATE_KNOWLEDGE_BASETool 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

string
New name for the knowledge base. Must be 1-200 characters if provided.
string
Type of the knowledge base (e.g., ‘gtc_pg_vector’, ‘pg_vector’, ‘gtc_hybrid_sql_pg_vector’). Must be 1-200 characters.
object
Configuration for the knowledge base vector store.
array
List of transformations to apply to the knowledge base data.
array
Updated list of asset paths to associate with this knowledge base.
string
Updated description of the knowledge base’s purpose. Must be 1-200 characters if provided.
string
The embedding model to use. Valid values: ‘text-embedding-ada-002’, ‘text-embedding-3-small’.
string
required
The unique identifier (UUID) of the knowledge base to update. Must be a valid UUID v4 format.
string
Cron or schedule expression for automated knowledge base updates. Must be 1-200 characters.
boolean
Whether to use the default embedding model for this knowledge base.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_UPDATE_LIBRARYUpdate an existing Griptape Cloud library’s configuration. The library name, data connector IDs, and knowledge base configurations must be supplied together; the description is optional.

Input Parameters

string
required
Updated name for the library. Must be between 1 and 64 characters.
string
required
The unique identifier (UUID) of the library to update.
string
Updated description of the library’s purpose. Must be between 1 and 256 characters if provided.
array
required
Updated list of data connector UUIDs to associate with this library. Can be an empty list.
array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_UPDATE_MESSAGETool 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

string
Updated input content of the message. The text or prompt that was sent to the assistant.
string
Updated output content or response of the message. The assistant’s response.
object
Updated metadata associated with the message. Can contain any additional key-value pairs.
string
required
The unique identifier (UUID) of the message to update. UUID v4 format (e.g., ‘4fe85c9a-c3e9-4a10-8985-705ba0694b62’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_UPDATE_MODELTool 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

boolean
Whether the model configuration should be active. Set to true to enable, false to disable.
object
Additional keyword arguments for the model configuration. Use for provider-specific settings.
string
Updated name of the model (e.g., ‘gpt-4’, ‘claude-3-opus’). Must be 1-1000 characters.
string ("chat" | "embedding" | "rerank" | "image_generation" | "unknown")
Enum representing the type of model.
string
Updated description of the model configuration’s purpose or characteristics.
string
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.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_UPDATE_MODEL_AUTH_CONFIGTool 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

string
New name for the model auth config. Must be 1-200 characters if provided.
object
Additional keyword arguments for the auth config.
string
Base URL for the model API endpoint.
string
required
Unique identifier (UUID) of the model auth config to update.
string
UUID of the API key secret to associate with this auth config.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_UPDATE_ORGANIZATIONTool 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

string
New name for the organization. Must be between 1 and 200 characters if provided.
object
Model configuration for the organization.
string
required
The unique identifier (UUID) of the organization to update. Must be a valid UUID v4 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_UPDATE_RETRIEVERTool 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

string
Updated name for the retriever. Must be 1-64 characters.
string
Updated description of the retriever’s purpose. Must be 1-256 characters.
string
required
The unique identifier (UUID) of the retriever to update. Must be a valid UUID v4 format.
array
Updated list of retriever component objects to create or update for this retriever. Each component must have ‘name’ and ‘type’ fields.
array
Updated list of retriever component UUIDs to associate with this retriever. Each ID must be a valid UUID v4 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_UPDATE_RETRIEVER_COMPONENTUpdate a Griptape Cloud retriever component by ID. The component type and configuration are required, and its name and description can also be updated.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_UPDATE_RULETool to update an existing rule’s configuration. Use when you need to modify a rule’s name, content, or metadata.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_UPDATE_RULESETTool to update an existing ruleset’s configuration. Use when you need to modify a ruleset’s name, description, alias, rules, or metadata.

Input Parameters

string
Updated name for the ruleset. Must be 1-200 characters if provided.
string
Updated alias identifier for the ruleset. Must be 1-200 characters if provided.
object
Updated key-value metadata pairs for storing custom attributes with the ruleset.
array
Updated list of rule UUIDs to associate with this ruleset.
string
required
Unique identifier (UUID) of the ruleset to update.
string
Updated description of the ruleset. Must be 1-200 characters if provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_UPDATE_SECRETTool 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

string
New name for the secret. Must be between 1 and 200 characters if provided.
string
New value for the secret. Must be between 1 and 200 characters if provided.
string
required
The unique identifier (UUID) of the secret to update. Must be a valid UUID v4 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_UPDATE_STRUCTURETool 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

object
Schema representing the code configuration for a structure.
string
New name for the structure. Must be 1-200 characters if provided.
array
Updated list of environment variables configured for the structure.
string
Updated description of the structure’s purpose. Must be 1-200 characters if provided.
string
required
Unique identifier (UUID) of the structure to update.
boolean
Whether to enable or disable webhooks for this structure.
string
Updated path to the structure configuration file. Must be 1-200 characters if provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_UPDATE_THREADTool 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

string
New name for the thread. Must be 1-200 characters if provided.
string
New alias for the thread. Must be 1-200 characters if provided.
array
List of messages to add or update in the thread. Each message requires ‘input’ and ‘output’ fields.
object
Additional metadata to associate with the thread.
string
required
Unique identifier (UUID) of the thread to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRIPTAPE_UPDATE_TOOLTool 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

object
Schema representing the code configuration for a tool.
string
Updated name for the tool. Must be 1-200 characters if provided.
string
required
Unique identifier (UUID) of the tool to update.
array
Updated list of environment variables for the tool.
string
Updated description of the tool. Must be 1-200 characters if provided.
string
Updated path to the tool configuration file. Must be 1-200 characters if provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not