Ai Development

Griptape

Learn how to use Griptape with Composio

Overview

SLUG: GRIPTAPE

Description

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

Authentication Details

generic_api_key
stringRequired

Connecting to Griptape

Create an auth config

Use the dashboard to create an auth config for the Griptape toolkit. This allows you to connect multiple Griptape accounts to Composio for agents to use.

1

Select App

Navigate to Griptape.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Griptape Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4griptape_auth_config_id = "ac_YOUR_GRIPTAPE_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10    # Replace this with a method to retrieve an API key from the user.
11    # Or supply your own.
12    user_api_key = input("[!] Enter API key")
13
14    connection_request = composio.connected_accounts.initiate(
15        user_id=user_id,
16        auth_config_id=auth_config_id,
17        config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18    )
19
20    # API Key authentication is immediate - no redirect needed
21    print(f"Successfully connected Griptape for user {user_id}")
22    print(f"Connection status: {connection_request.status}")
23    
24    return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, griptape_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Griptape toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["GRIPTAPE"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Assistant Creation

Description

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

Action Parameters

alias
stringRequired
description
string
metadata
object
model
string
system_prompt
string
tools
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Assistants

Description

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

Action Parameters

limit
integer
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Cancel Assistant Run

Description

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

Action Parameters

assistant_run_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Assistant Run Creation

Description

Tool to initiate a new assistant run. Use when starting a fresh execution with custom arguments or resources after selecting the assistant.

Action Parameters

additional_knowledge_base_ids
array
additional_ruleset_ids
array
additional_structure_ids
array
additional_tool_ids
array
args
array
assistant_id
stringRequired
input
object
knowledge_base_ids
array
ruleset_ids
array
stream
boolean
structure_ids
array
thread_id
string
tool_ids
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Assistant Run Error Details

Description

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

Action Parameters

run_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Stream Assistant Run Events

Description

Tool to stream real-time events for a specific Assistant run. Use after initiating a run to monitor its progress.

Action Parameters

assistant_run_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Assistant Runs

Description

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

Action Parameters

assistant_id
stringRequired
limit
integer
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Assistant Run Logs Retrieval

Description

Tool to retrieve logs generated during the execution of a specific assistant run. Use after confirming the run_id to fetch all log events once the run has completed.

Action Parameters

assistant_run_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Assistant Run Result Retrieval

Description

Tool to fetch the final result of a completed assistant run. Use after confirming the run has finished to retrieve its final assistant-generated output.

Action Parameters

run_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve Assistant Run

Description

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

Action Parameters

assistant_run_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retry Assistant Run

Description

Tool to retry a previously failed assistant run. Use when a run has failed and you need to rerun it with the same parameters.

Action Parameters

run_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Ruleset by Alias

Description

Tool to retrieve a ruleset by its alias. Use after confirming the alias to fetch the ruleset's details from Griptape Cloud.

Action Parameters

alias
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Embedding Drivers

Description

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

Action Parameters

endpoint_override
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Ruleset Creation

Description

Tool to create a new ruleset. Use when you need to define a new set of rules with a unique alias before executing runs.

Action Parameters

alias
stringRequired
metadata
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Tool

Description

Tool to create a new tool in Griptape Cloud. Use when you need to deploy a tool from a Git repo or ZIP archive.

Action Parameters

branch
string
git_url
string
name
stringRequired
zip_url
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Tool Deployment Status

Description

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

Action Parameters

deployment_id
stringRequired
tool_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Tools

Description

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired