Griptape/assistants
@webframp/griptape/assistantsv2026.08.29.1
01README
Griptape Cloud Assistants — assistant definitions and assistant runs
02Release Notes
2026.08.29.1
Added: Initial code-generated release of @webframp/griptape/assistants with 10 methods covering the Griptape Cloud assistants API surface.
03Models
@webframp/griptape/assistantsv2026.08.29.1griptape/assistants.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| apiKey? | string | Griptape Cloud API key; overrides the GT_CLOUD_API_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| baseUrl? | string | Griptape Cloud API base URL; overrides the GT_CLOUD_BASE_URL environment variable and the built-in default. |
fn get_assistant_run(assistant_run_id: string)
get operation
| Argument | Type | Description |
|---|---|---|
| assistant_run_id | string |
fn cancel_assistant_run(assistant_run_id: string)
action operation
| Argument | Type | Description |
|---|---|---|
| assistant_run_id | string |
fn list_assistant_events(assistant_run_id: string, limit?: string, offset?: string)
list operation
| Argument | Type | Description |
|---|---|---|
| assistant_run_id | string | |
| limit? | string | |
| offset? | string |
fn list_assistants(page?: number, page_size?: number)
list operation
| Argument | Type | Description |
|---|---|---|
| page? | number | |
| page_size? | number |
fn create_assistant(description?: string, input?: string, knowledge_base_ids?: array, model?: string, name: string, retriever_ids?: array, ruleset_ids?: array, structure_ids?: array, tool_ids?: array)
create operation
| Argument | Type | Description |
|---|---|---|
| description? | string | |
| input? | string | |
| knowledge_base_ids? | array | |
| model? | string | |
| name | string | |
| retriever_ids? | array | |
| ruleset_ids? | array | |
| structure_ids? | array | |
| tool_ids? | array |
fn get_assistant(assistant_id: string)
get operation
| Argument | Type | Description |
|---|---|---|
| assistant_id | string |
fn update_assistant(assistant_id: string, description?: string, input?: string, knowledge_base_ids?: array, model?: string, name?: string, ruleset_ids?: array, structure_ids?: array, tool_ids?: array)
update operation
| Argument | Type | Description |
|---|---|---|
| assistant_id | string | |
| description? | string | |
| input? | string | |
| knowledge_base_ids? | array | |
| model? | string | |
| name? | string | |
| ruleset_ids? | array | |
| structure_ids? | array | |
| tool_ids? | array |
fn delete_assistant(assistant_id: string)
delete operation
| Argument | Type | Description |
|---|---|---|
| assistant_id | string |
fn list_assistant_runs(assistant_id: string, page?: number, page_size?: number, status?: string)
list operation
| Argument | Type | Description |
|---|---|---|
| assistant_id | string | |
| page? | number | |
| page_size? | number | |
| status? | string | Comma-separated list of run statuses to filter by. |
fn create_assistant_run(assistant_id: string, additional_knowledge_base_ids?: array, additional_retriever_ids?: array, additional_ruleset_ids?: array, additional_structure_ids?: array, additional_tool_ids?: array, args?: array, input?: string, knowledge_base_ids?: array, model?: string, new_thread?: boolean, retriever_ids?: array, ruleset_ids?: array, stream?: boolean, structure_ids?: array, thread_id?: string, tool_ids?: array)
create operation
| Argument | Type | Description |
|---|---|---|
| assistant_id | string | |
| additional_knowledge_base_ids? | array | |
| additional_retriever_ids? | array | |
| additional_ruleset_ids? | array | |
| additional_structure_ids? | array | |
| additional_tool_ids? | array | |
| args? | array | |
| input? | string | |
| knowledge_base_ids? | array | |
| model? | string | |
| new_thread? | boolean | If true, create a new thread for this run to be returned in the response thread_id. |
| retriever_ids? | array | |
| ruleset_ids? | array | |
| stream? | boolean | |
| structure_ids? | array | |
| thread_id? | string | If provided, the run will be associated with the given thread. This takes precedence over new_thr... |
| tool_ids? | array |
Resources
assistant_run(infinite)— get operation
assistant_events(infinite)— list operation
assistants(infinite)— list operation
assistant(infinite)— create operation
assistant_runs(infinite)— list operation
04Stats
A
100 / 100
Downloads
0
Archive size
17.3 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels