Griptape

Integrate Griptape with your AI workspace

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

Explore Triggers and Actions

Assistant Creation

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

ActionTry it

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.

ActionTry it

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.

ActionTry it

Cancel Assistant Run

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

ActionTry it

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.

ActionTry it

Create Bucket

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

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

Create Model Configuration

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

Create Rule

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

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

Create Tool

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.

ActionTry it

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.

ActionTry it

Delete API Key

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

ActionTry it

Delete Assistant

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

ActionTry it

Delete Bucket

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

ActionTry it

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.

ActionTry it

Delete Data Connector

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

ActionTry it

Delete Function

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

ActionTry it

Delete Integration

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

ActionTry it

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.

ActionTry it

Delete Library

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

ActionTry it

Delete Message

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

ActionTry it

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.

ActionTry it

Delete Model Configuration

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

ActionTry it

Delete Rule

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

ActionTry it

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.

ActionTry it

Delete Secret

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

ActionTry it

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.

ActionTry it

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.

ActionTry it

Delete Tool

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

ActionTry it

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.

ActionTry it

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.

ActionTry it

Get 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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

Get Configuration

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

ActionTry it

Get Credits Balance

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

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

Get Model Configuration

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

Get Structures Dashboard

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

ActionTry it

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.

ActionTry it

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.

ActionTry it

Get Tool Deployment Status

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

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

List Assistant Runs

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

ActionTry it

List Assistants

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

ActionTry it

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.

ActionTry it

List Buckets

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

ActionTry it

List Connections

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

ActionTry it

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.

ActionTry it

List Embedding Drivers

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

ActionTry it

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.

ActionTry it

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.

ActionTry it

List Functions

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

ActionTry it

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.

ActionTry it

List Integrations

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

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

List Knowledge Bases

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

ActionTry it

List Libraries

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

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

List Organizations

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

ActionTry it

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.

ActionTry it

List Retrievers

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

ActionTry it

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.

ActionTry it

List Secrets

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

ActionTry it

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.

ActionTry it

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.

ActionTry it

List Structures

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

ActionTry it

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.

ActionTry it

List Threads

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

ActionTry it

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.

ActionTry it

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.

ActionTry it

List Tools

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

ActionTry it

List Users

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

ActionTry it

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.

ActionTry it

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.

ActionTry it

Retrieve Assistant Run

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

ActionTry it

Retry Assistant Run

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.

ActionTry it

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.

ActionTry it

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?"

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

Update Model Configuration

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

Update Rule

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

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it

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.

ActionTry it