Griptape/knowledge Bases
@webframp/griptape/knowledge-basesv2026.08.29.1
01README
Griptape Cloud Knowledge Bases — RAG knowledge bases, queries, searches, and index jobs
02Release Notes
2026.08.29.1
Added: Initial code-generated release of @webframp/griptape/knowledge-bases with 15 methods covering the Griptape Cloud knowledge bases API surface.
03Models
@webframp/griptape/knowledge-basesv2026.08.29.1griptape/knowledge_bases.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_knowledge_base_job(knowledge_base_job_id: string)
get operation
| Argument | Type | Description |
|---|---|---|
| knowledge_base_job_id | string |
fn cancel_knowledge_base_job(knowledge_base_job_id: string)
action operation
| Argument | Type | Description |
|---|---|---|
| knowledge_base_job_id | string |
fn get_knowledge_base_query(knowledge_base_query_id: string)
get operation
| Argument | Type | Description |
|---|---|---|
| knowledge_base_query_id | string |
fn get_knowledge_base_search(knowledge_base_search_id: string)
get operation
| Argument | Type | Description |
|---|---|---|
| knowledge_base_search_id | string |
fn list_knowledge_bases(page?: number, page_size?: number)
list operation
| Argument | Type | Description |
|---|---|---|
| page? | number | |
| page_size? | number |
fn create_knowledge_base(asset_paths?: array, config: unknown, description?: string, embedding_model?: unknown, name: string, transforms?: array, type: string, use_default_embedding_model?: boolean)
create operation
| Argument | Type | Description |
|---|---|---|
| asset_paths? | array | |
| config | unknown | |
| description? | string | |
| embedding_model? | unknown | |
| name | string | |
| transforms? | array | |
| type | string | |
| use_default_embedding_model? | boolean |
fn get_knowledge_base(knowledge_base_id: string)
get operation
| Argument | Type | Description |
|---|---|---|
| knowledge_base_id | string |
fn update_knowledge_base(knowledge_base_id: string, asset_paths?: array, config: unknown, description?: string, embedding_model?: unknown, name?: string, schedule_expression?: string, transforms?: array, type: string, use_default_embedding_model?: boolean)
update operation
| Argument | Type | Description |
|---|---|---|
| knowledge_base_id | string | |
| asset_paths? | array | |
| config | unknown | |
| description? | string | |
| embedding_model? | unknown | |
| name? | string | |
| schedule_expression? | string | |
| transforms? | array | |
| type | string | |
| use_default_embedding_model? | boolean |
fn delete_knowledge_base(knowledge_base_id: string)
delete operation
| Argument | Type | Description |
|---|---|---|
| knowledge_base_id | string |
fn list_knowledge_base_jobs(knowledge_base_id: string, page?: number, page_size?: number, status?: string)
list operation
| Argument | Type | Description |
|---|---|---|
| knowledge_base_id | string | |
| page? | number | |
| page_size? | number | |
| status? | string | Comma-separated list of statuses to filter by. |
fn create_knowledge_base_job(knowledge_base_id: string)
create operation
| Argument | Type | Description |
|---|---|---|
| knowledge_base_id | string |
fn list_knowledge_base_queries(knowledge_base_id: string, page?: number, page_size?: number)
list operation
| Argument | Type | Description |
|---|---|---|
| knowledge_base_id | string | |
| page? | number | |
| page_size? | number |
fn query_knowledge_base(knowledge_base_id: string, query?: string, query_args?: unknown)
action operation
| Argument | Type | Description |
|---|---|---|
| knowledge_base_id | string | |
| query? | string | |
| query_args? | unknown |
fn search_knowledge_base(knowledge_base_id: string, query: string, query_args?: unknown)
action operation
| Argument | Type | Description |
|---|---|---|
| knowledge_base_id | string | |
| query | string | |
| query_args? | unknown |
fn list_knowledge_base_searches(knowledge_base_id: string, page?: number, page_size?: number)
list operation
| Argument | Type | Description |
|---|---|---|
| knowledge_base_id | string | |
| page? | number | |
| page_size? | number |
Resources
knowledge_base_job(infinite)— get operation
knowledge_base_query(infinite)— get operation
knowledge_base_search(infinite)— get operation
knowledge_bases(infinite)— list operation
knowledge_base(infinite)— create operation
knowledge_base_jobs(infinite)— list operation
knowledge_base_queries(infinite)— list operation
knowledge_base_searches(infinite)— list operation
04Stats
A
100 / 100
Downloads
0
Archive size
17.8 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