The Griptape connector lets your AI agent act in each user's Griptape account. Each user connects their own Griptape access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 59 tools.
- Tools
- 59
- What they doRead · write · destructive
- 35 · 15 · 935 read15 write9 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Griptape connection
In AgentKit > Connections, create a Griptape connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'griptape'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Griptape:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'griptape_buckets_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "griptape"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Griptape:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="griptape_buckets_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Griptape credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolgriptape_bucket_asset_getGet the metadata of one file in a Griptape Cloud bucket.Read-onlyGet Bucket Asset
Get the metadata of one file in a Griptape Cloud bucket. Returns the asset's name, size, content type and timestamps. Use this to check a file exists.
Inputs
bucket_idstringrequired- ID of the bucket, from griptape_buckets_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
namestringrequired- Asset name (path in the bucket). Example: faq.pdf.
griptape_bucket_assets_listList the files (assets) in a Griptape Cloud bucket, optionally by name prefix or suffix.Read-onlyList Bucket Assets
List the files (assets) in a Griptape Cloud bucket, optionally by name prefix or suffix. Returns assets with name, size, content type and timestamps. Use this to browse a bucket.
Inputs
bucket_idstringrequired- ID of the bucket, from griptape_buckets_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
pageinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 20.
postfixstring- Only assets whose name ends with this text. Example: .pdf.
prefixstring- Only assets whose name starts with this text. Example: faq/.
griptape_bucket_getGet one Griptape Cloud bucket.Read-onlyGet Bucket
Get one Griptape Cloud bucket. Returns the bucket's name and timestamps. Use this for a bucket's details.
Inputs
bucket_idstringrequired- ID of the bucket, from griptape_buckets_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
griptape_buckets_listList Griptape Cloud data buckets (file storage).Read-onlyList Buckets
List Griptape Cloud data buckets (file storage). Returns buckets with ID, name and timestamps. Use this to find a bucket.
Inputs
pageinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 20.
griptape_credit_balance_getGet the Griptape Cloud credit balance of your organization.Read-onlyGet Credit Balance
Get the Griptape Cloud credit balance of your organization. Returns the remaining credits. Use this before running large jobs.
Inputs
This tool takes no inputs.
griptape_credit_transactions_listList Griptape Cloud credit transactions (purchases and usage).Read-onlyList Credit Transactions
List Griptape Cloud credit transactions (purchases and usage). Returns transactions with amount, type and timestamp. Use this to audit credit spend.
Inputs
pageinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 20.
griptape_deployment_getGet one Griptape Cloud deployment.Read-onlyGet Deployment
Get one Griptape Cloud deployment. Returns the deployment's status, code source, logs location and timestamps. Use this to follow a build.
Inputs
deployment_idstringrequired- ID of the deployment, from griptape_structure_deployments_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
griptape_event_getGet one event emitted by a Griptape Cloud structure run.Read-onlyGet Event
Get one event emitted by a Griptape Cloud structure run. Returns the event's type, payload and timestamp. Use this for one event's full payload.
Inputs
event_idstringrequired- ID of the event, from griptape_structure_run_events_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
griptape_integration_getGet one Griptape Cloud integration.Read-onlyGet Integration
Get one Griptape Cloud integration. Returns the integration's name, type, configuration and linked structures. Use this for an integration's details.
Inputs
integration_idstringrequired- ID of the integration, from griptape_integrations_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
griptape_integrations_listList the Griptape Cloud integrations (such as Slack or webhook triggers) that connect structures to other services.Read-onlyList Integrations
List the Griptape Cloud integrations (such as Slack or webhook triggers) that connect structures to other services. Returns integrations with ID, name, type and the structures they trigger. Use this to see how structures are triggered.
Inputs
pageinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 20.
griptape_message_getGet one message of a Griptape Cloud thread.Read-onlyGet Message
Get one message of a Griptape Cloud thread. Returns the message's input, output and metadata. Use this for one turn's details.
Inputs
message_idstringrequired- ID of the message, from griptape_thread_messages_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
griptape_model_getGet one Griptape Cloud model configuration.Read-onlyGet Model
Get one Griptape Cloud model configuration. Returns the model's name, provider, type and settings. Use this for a model's details.
Inputs
model_config_idstringrequired- ID of the model configuration, from griptape_models_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
griptape_models_listList the model configurations available in Griptape Cloud, optionally by type or only defaults.Read-onlyList Models
List the model configurations available in Griptape Cloud, optionally by type or only defaults. Returns models with ID, name, provider and type. Use this to see which LLMs and embedding models can be used.
Inputs
defaultboolean- True lists only the default models. Example: true.
model_typestring- Model type filter, such as prompt or embedding. Example: prompt.
pageinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 20.
griptape_organizations_listList the Griptape Cloud organizations the API key's user belongs to.Read-onlyList Organizations
List the Griptape Cloud organizations the API key's user belongs to. Returns organizations with ID, name and entitlement. Use this to check which organization the key works in.
Inputs
This tool takes no inputs.
griptape_rule_getGet one Griptape Cloud rule.Read-onlyGet Rule
Get one Griptape Cloud rule. Returns the rule's name, text and metadata. Use this for a rule's details.
Inputs
rule_idstringrequired- ID of the rule, from griptape_rules_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
griptape_rules_listList Griptape Cloud rules, optionally only those in one ruleset.Read-onlyList Rules
List Griptape Cloud rules, optionally only those in one ruleset. Returns rules with ID, name, rule text and metadata. Use this to find rules.
Inputs
pageinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 20.
ruleset_idstring- Only rules in this ruleset. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
griptape_ruleset_getGet one Griptape Cloud ruleset.Read-onlyGet Ruleset
Get one Griptape Cloud ruleset. Returns the ruleset's name, alias, description and rule IDs. Use this for a ruleset's details.
Inputs
ruleset_idstringrequired- ID of the ruleset, from griptape_rulesets_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
griptape_rulesets_listList Griptape Cloud rulesets (groups of rules that steer agent behavior), optionally by alias.Read-onlyList Rulesets
List Griptape Cloud rulesets (groups of rules that steer agent behavior), optionally by alias. Returns rulesets with ID, name, alias, description and rule IDs. Use this to find a ruleset.
Inputs
aliasstring- Only the ruleset with this alias. Example: support-tone.
pageinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 20.
griptape_secrets_listList the Griptape Cloud secrets (names only; values are never returned).Read-onlyList Secrets
List the Griptape Cloud secrets (names only; values are never returned). Returns secrets with ID, name and timestamps. Use this to find a secret ID for a structure's environment variables.
Inputs
pageinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 20.
griptape_structure_deployments_listList the deployments (builds) of a Griptape Cloud structure.Read-onlyList Structure Deployments
List the deployments (builds) of a Griptape Cloud structure. Returns deployments with ID, status, code version and timestamps. Use this to check whether the latest code built successfully.
Inputs
structure_idstringrequired- ID of the structure, from griptape_structures_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
pageinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 20.
griptape_structure_getGet one Griptape Cloud structure.Read-onlyGet Structure
Get one Griptape Cloud structure. Returns the structure's name, description, code source, environment variable names and webhook setting. Use this for a structure's details.
Inputs
structure_idstringrequired- ID of the structure, from griptape_structures_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
griptape_structure_run_events_listList the events a Griptape Cloud structure run emitted, such as task starts, tool calls and the final output.Read-onlyList Structure Run Events
List the events a Griptape Cloud structure run emitted, such as task starts, tool calls and the final output. Returns events with type, payload and timestamp. Use this to see what an agent did step by step.
Inputs
structure_run_idstringrequired- ID of the structure run, from griptape_structure_runs_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
limitstring- Maximum number of events to return. Example: 50.
offsetstring- Number of events to skip. Example: 0.
griptape_structure_run_getGet one Griptape Cloud structure run.Read-onlyGet Structure Run
Get one Griptape Cloud structure run. Returns the run's status, arguments, output, errors and timestamps. Use this to poll a run until it reaches SUCCEEDED or FAILED.
Inputs
structure_run_idstringrequired- ID of the structure run, from griptape_structure_runs_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
griptape_structure_run_logs_listList the logs of a Griptape Cloud structure run.Read-onlyList Structure Run Logs
List the logs of a Griptape Cloud structure run. Returns log lines with timestamps. Use this to debug a failed run.
Inputs
structure_run_idstringrequired- ID of the structure run, from griptape_structure_runs_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
griptape_structure_runs_listList the runs of a Griptape Cloud structure, optionally by status.Read-onlyList Structure Runs
List the runs of a Griptape Cloud structure, optionally by status. Returns runs with ID, status, arguments, output and timestamps. Use this to find recent runs. Use griptape_structure_run_get for one run.
Inputs
structure_idstringrequired- ID of the structure, from griptape_structures_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
pageinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 20.
statusstring- Comma-separated run statuses to filter by, such as SUCCEEDED,FAILED (also QUEUED, RUNNING, CANCELLED, ERROR). Example: SUCCEEDED,FAILED.
griptape_structures_listList the Griptape Cloud structures (deployed agents, pipelines and workflows) in your organization.Read-onlyList Structures
List the Griptape Cloud structures (deployed agents, pipelines and workflows) in your organization. Returns structures with ID, name, description, code source and latest deployment. Use this to find a structure to run. Use griptape_structure_run_create to run one.
Inputs
pageinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 20.
griptape_thread_getGet one Griptape Cloud thread.Read-onlyGet Thread
Get one Griptape Cloud thread. Returns the thread's name, alias, metadata and message count. Use this for a thread's details.
Inputs
thread_idstringrequired- ID of the thread, from griptape_threads_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
griptape_thread_messages_listList the messages (input and output turns) in a Griptape Cloud thread.Read-onlyList Thread Messages
List the messages (input and output turns) in a Griptape Cloud thread. Returns messages with ID, input, output, metadata and timestamps. Use this to read a conversation.
Inputs
thread_idstringrequired- ID of the thread, from griptape_threads_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
pageinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 20.
griptape_threads_listList Griptape Cloud conversation threads (conversation memory), optionally by alias or name prefix.Read-onlyList Threads
List Griptape Cloud conversation threads (conversation memory), optionally by alias or name prefix. Returns threads with ID, name, alias, message count and metadata. Use this to find a thread. Use griptape_thread_messages_list for its messages.
Inputs
aliasstring- Only the thread with this alias. Example: customer-123.
pageinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 20.
starts_withstring- Only threads whose name starts with this text. Example: Support.
griptape_tool_getGet one Griptape Cloud tool.Read-onlyGet Tool
Get one Griptape Cloud tool. Returns the tool's name, description, code source and settings. Use this for a tool's details.
Inputs
tool_idstringrequired- ID of the tool, from griptape_tools_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
griptape_tool_run_getGet one Griptape Cloud tool run.Read-onlyGet Tool Run
Get one Griptape Cloud tool run. Returns the run's activity, status, input, output and timestamps. Use this for one call's result.
Inputs
tool_run_idstringrequired- ID of the tool run, from griptape_tool_runs_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
griptape_tool_run_logs_listList the logs of a Griptape Cloud tool run.Read-onlyList Tool Run Logs
List the logs of a Griptape Cloud tool run. Returns log lines with timestamps. Use this to debug a failed tool call.
Inputs
tool_run_idstringrequired- ID of the tool run, from griptape_tool_runs_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
griptape_tool_runs_listList the runs of a Griptape Cloud tool.Read-onlyList Tool Runs
List the runs of a Griptape Cloud tool. Returns runs with ID, activity, status, input, output and timestamps. Use this to see how a tool has been called.
Inputs
tool_idstringrequired- ID of the tool, from griptape_tools_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
pageinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 20.
griptape_tools_listList the Griptape Cloud tools (deployed tool services agents can call).Read-onlyList Tools
List the Griptape Cloud tools (deployed tool services agents can call). Returns tools with ID, name, description and latest deployment. Use this to find a tool.
Inputs
pageinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 20.
griptape_usage_getGet Griptape Cloud usage for your organization.Read-onlyGet Usage
Get Griptape Cloud usage for your organization. Returns usage totals such as run minutes and tokens for the current period. Use this to monitor consumption.
Inputs
This tool takes no inputs.
griptape_bucket_asset_url_createCreate a presigned URL to download (GET) or upload (PUT) a file in a Griptape Cloud bucket.WriteCreate Asset URL
Create a presigned URL to download (GET) or upload (PUT) a file in a Griptape Cloud bucket. Returns the presigned URL and its expiry. Use this to read a file's contents or upload a new file directly to storage.
Inputs
bucket_idstringrequired- ID of the bucket, from griptape_buckets_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
namestringrequired- Asset name (path in the bucket). Example: faq.pdf.
operationstringrequired- GET to download or PUT to upload. Example: GET.one of
PUTGET content_typestring- MIME type for an upload URL, overriding the type guessed from the name. Example: application/pdf.
griptape_bucket_createCreate a Griptape Cloud data bucket.WriteCreate Bucket
Create a Griptape Cloud data bucket. Returns the created bucket with its ID. Use this to store files for structures and data sources.
Inputs
namestringrequired- Bucket name. Example: support-docs.
griptape_message_updateUpdate the input, output or metadata of a Griptape Cloud thread message.WriteUpdate Message
Update the input, output or metadata of a Griptape Cloud thread message. Returns the updated message. Use this to correct a saved turn.
- Idempotent
Inputs
message_idstringrequired- ID of the message, from griptape_thread_messages_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
inputstring- New input text. Example: Where is my order #1001?.
metadataobject- Your own key-value metadata as a JSON object. Example: {"team": "support"}
outputstring- New output text. Example: Order #1001 shipped yesterday.
griptape_rule_createCreate a Griptape Cloud rule: one instruction an agent should follow.WriteCreate Rule
Create a Griptape Cloud rule: one instruction an agent should follow. Returns the created rule with its ID. Use this before adding the rule to a ruleset.
Inputs
namestringrequired- Rule name. Example: Be concise.
rulestringrequired- The instruction text. Example: Answer in at most three sentences.
metadataobject- Your own key-value metadata as a JSON object. Example: {"team": "support"}
griptape_rule_updateUpdate a Griptape Cloud rule's name, text or metadata.WriteUpdate Rule
Update a Griptape Cloud rule's name, text or metadata. Returns the updated rule. Use this to change an instruction.
- Idempotent
Inputs
rule_idstringrequired- ID of the rule, from griptape_rules_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
metadataobject- Your own key-value metadata as a JSON object. Example: {"team": "support"}
namestring- New name. Example: Be concise.
rulestring- New instruction text. Example: Answer in at most two sentences.
griptape_ruleset_createCreate a Griptape Cloud ruleset from existing rules.WriteCreate Ruleset
Create a Griptape Cloud ruleset from existing rules. Returns the created ruleset with its ID. Use this to group rules an agent should follow. Use griptape_rule_create first to create the rules.
Inputs
namestringrequired- Ruleset name. Example: Support tone.
aliasstring- Unique alias to look the ruleset up by. Example: support-tone.
descriptionstring- What the ruleset is for. Example: How the support agent should write.
metadataobject- Your own key-value metadata as a JSON object. Example: {"team": "support"}
rule_idsarray- IDs of the rules in the ruleset. Example: ["3f1e2d4c-5b6a-4789-9abc-def012345678"]
griptape_ruleset_updateUpdate a Griptape Cloud ruleset's name, alias, description, rules or metadata; rule_ids replaces the list.WriteUpdate Ruleset
Update a Griptape Cloud ruleset's name, alias, description, rules or metadata; rule_ids replaces the list. Returns the updated ruleset. Use this to add or remove rules from a ruleset.
- Idempotent
Inputs
ruleset_idstringrequired- ID of the ruleset, from griptape_rulesets_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
aliasstring- New alias. Example: support-tone.
descriptionstring- New description. Example: How the support agent should write.
metadataobject- Your own key-value metadata as a JSON object. Example: {"team": "support"}
namestring- New name. Example: Support tone v2.
rule_idsarray- IDs of the rules in the ruleset; replaces the current list. Example: ["3f1e2d4c-5b6a-4789-9abc-def012345678"]
griptape_secret_createStore a secret value in Griptape Cloud, such as a third-party API key for a structure.WriteCreate Secret
Store a secret value in Griptape Cloud, such as a third-party API key for a structure. Returns the created secret with its ID (not the value). Use this before referencing the secret in env_vars with source secret_ref.
Inputs
namestringrequired- Secret name. Example: OPENAI_API_KEY.
valuestringrequired- Secret value. Example: sk-example-value.
griptape_secret_updateRename a Griptape Cloud secret or replace its value.WriteUpdate Secret
Rename a Griptape Cloud secret or replace its value. Returns the updated secret (not the value). Use this to rotate a key.
- Idempotent
Inputs
secret_idstringrequired- ID of the secret, from griptape_secrets_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
namestring- New name. Example: OPENAI_API_KEY.
valuestring- New secret value. Example: sk-new-example-value.
griptape_structure_run_cancelCancel a queued or running Griptape Cloud structure run.WriteCancel Structure Run
Cancel a queued or running Griptape Cloud structure run. Returns the run with status CANCELLED. Use this to stop a run that is no longer needed.
- Idempotent
Inputs
structure_run_idstringrequired- ID of the structure run, from griptape_structure_runs_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
griptape_structure_run_createStart a run of a Griptape Cloud structure with arguments, such as the user's prompt.WriteRun Structure
Start a run of a Griptape Cloud structure with arguments, such as the user's prompt. Returns the run with its ID and status (QUEUED or RUNNING). Use this to call a deployed agent. Use griptape_structure_run_get to wait for the output.
Inputs
argsarrayrequired- Positional arguments passed to the structure, such as the prompt. Example: ["Summarize the latest support tickets"]
structure_idstringrequired- ID of the structure, from griptape_structures_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
env_varsarray- Environment variables for this run, each an object with name, value and source (manual or secret_ref). Example: [{"name": "LOG_LEVEL", "value": "debug", "source": "manual"}]
griptape_structure_updateUpdate a Griptape Cloud structure's name, description, webhook setting or environment variables.WriteUpdate Structure
Update a Griptape Cloud structure's name, description, webhook setting or environment variables. Returns the updated structure. Use this to rename a structure or change its default environment.
- Idempotent
Inputs
structure_idstringrequired- ID of the structure, from griptape_structures_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
descriptionstring- New description. Example: Classifies and routes incoming tickets.
env_varsarray- Default environment variables, each an object with name, value and source (manual or secret_ref, where value is a secret ID). Example: [{"name": "LOG_LEVEL", "value": "info", "source": "manual"}]
namestring- New name. Example: Support triage agent.
webhook_enabledboolean- True lets the structure be invoked through its webhook URL. Example: false.
griptape_thread_createCreate a Griptape Cloud conversation thread for storing an agent's conversation memory.WriteCreate Thread
Create a Griptape Cloud conversation thread for storing an agent's conversation memory. Returns the created thread with its ID. Use this to start a conversation. Use griptape_thread_message_create to add turns.
Inputs
namestringrequired- Thread name. Example: Support chat with customer 123.
aliasstring- Unique alias to look the thread up by. Example: customer-123.
metadataobject- Your own key-value metadata as a JSON object. Example: {"team": "support"}
griptape_thread_message_createAdd a message (one input and output turn) to a Griptape Cloud thread.WriteCreate Thread Message
Add a message (one input and output turn) to a Griptape Cloud thread. Returns the created message with its ID. Use this to save a conversation turn to memory.
Inputs
inputstringrequired- The user's input for this turn. Example: Where is my order?.
outputstringrequired- The assistant's output for this turn. Example: Your order shipped yesterday and arrives Friday.
thread_idstringrequired- ID of the thread, from griptape_threads_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
metadataobject- Your own key-value metadata as a JSON object. Example: {"team": "support"}
griptape_thread_updateRename a Griptape Cloud thread or change its alias or metadata.WriteUpdate Thread
Rename a Griptape Cloud thread or change its alias or metadata. Returns the updated thread. Use this to tag or rename a conversation.
- Idempotent
Inputs
thread_idstringrequired- ID of the thread, from griptape_threads_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
aliasstring- New alias. Example: customer-123.
metadataobject- Your own key-value metadata as a JSON object. Example: {"team": "support"}
namestring- New name. Example: Support chat (resolved)
griptape_bucket_asset_deleteDelete a file from a Griptape Cloud bucket.DestructiveDelete Bucket Asset
Delete a file from a Griptape Cloud bucket. Returns an empty success response. Use this to remove a stored file.
- Idempotent
Inputs
bucket_idstringrequired- ID of the bucket, from griptape_buckets_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
namestringrequired- Asset name (path in the bucket). Example: faq.pdf.
griptape_bucket_deleteDelete a Griptape Cloud bucket and its files.DestructiveDelete Bucket
Delete a Griptape Cloud bucket and its files. Returns an empty success response. Use this to remove stored files for good.
- Idempotent
Inputs
bucket_idstringrequired- ID of the bucket, from griptape_buckets_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
griptape_message_deleteDelete a message from a Griptape Cloud thread.DestructiveDelete Message
Delete a message from a Griptape Cloud thread. Returns an empty success response. Use this to remove a turn from memory.
- Idempotent
Inputs
message_idstringrequired- ID of the message, from griptape_thread_messages_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
griptape_rule_deleteDelete a Griptape Cloud rule.DestructiveDelete Rule
Delete a Griptape Cloud rule. Returns an empty success response. Use this to remove an instruction.
- Idempotent
Inputs
rule_idstringrequired- ID of the rule, from griptape_rules_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
griptape_ruleset_deleteDelete a Griptape Cloud ruleset; its rules are kept.DestructiveDelete Ruleset
Delete a Griptape Cloud ruleset; its rules are kept. Returns an empty success response. Use this to remove a ruleset.
- Idempotent
Inputs
ruleset_idstringrequired- ID of the ruleset, from griptape_rulesets_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
griptape_secret_deleteDelete a Griptape Cloud secret.DestructiveDelete Secret
Delete a Griptape Cloud secret. Returns an empty success response. Use this to remove a stored key.
- Idempotent
Inputs
secret_idstringrequired- ID of the secret, from griptape_secrets_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
griptape_structure_deleteDelete a Griptape Cloud structure and its deployments.DestructiveDelete Structure
Delete a Griptape Cloud structure and its deployments. Returns an empty success response. Use this to remove a structure for good.
- Idempotent
Inputs
structure_idstringrequired- ID of the structure, from griptape_structures_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
griptape_thread_deleteDelete a Griptape Cloud thread and its messages.DestructiveDelete Thread
Delete a Griptape Cloud thread and its messages. Returns an empty success response. Use this to erase a conversation.
- Idempotent
Inputs
thread_idstringrequired- ID of the thread, from griptape_threads_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
griptape_tool_deleteDelete a Griptape Cloud tool.DestructiveDelete Tool
Delete a Griptape Cloud tool. Returns an empty success response. Use this to remove a tool for good.
- Idempotent
Inputs
tool_idstringrequired- ID of the tool, from griptape_tools_list. Example: 3f1e2d4c-5b6a-4789-9abc-def012345678.
No tools match.