Griptape/knowledge Bases

@webframp/griptape/knowledge-basesv2026.10.21.1· Apache-2.0· 5d agoBEHAVIORS

01README

Griptape Cloud Knowledge Bases — RAG knowledge bases, queries, searches, and index jobs

02Release Notes

2026.10.21.1

Changed: The README now opens with a Credentials section. Store the key with swamp vault put griptape API_KEY and set apiKey to ${{ vault.get("griptape", "API_KEY") }}. The previous example passed a placeholder literal (apiKey=GRIPTAPE_CLOUD_API_KEY).

Changed: The apiKey description and the missing-key error now point to the vault. The GT_CLOUD_API_KEY environment variable is still read when apiKey is unset, but it is now documented as a discouraged fallback because swamp does not redact it. Key resolution is unchanged.

Fixed: The config argument of create_knowledge_base and update_knowledge_base, which can carry a pgvector password, was not marked sensitive, so swamp did not redact it. It is now.

Added: The README lists these arguments and tells you to put a vault.get expression on the password field. A literal value is recorded in cleartext with the run's inputs.

Upgrade note: No resource schema changes. Only argument redaction changed.

03Behaviors1

@webframp/griptape/knowledge-basesv2026.10.21.1griptape/knowledge_bases.ts

Global Arguments

Argument	Type	Required	Description
apiKey?	string	no	Griptape Cloud API key. Store it in a swamp vault and wire it with a vault.get(...) expression, e.g. ${{ vault.get("griptape", "API_KEY") }}. The GT_CLOUD_API_KEY environment variable is read as a fallback, but it is not redacted and is not recommended.
baseUrl?	string	no	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	Required	Description
knowledge_base_job_id	string	yes

fn cancel_knowledge_base_job(knowledge_base_job_id: string)

action operation

Argument	Type	Required	Description
knowledge_base_job_id	string	yes

fn get_knowledge_base_query(knowledge_base_query_id: string)

get operation

Argument	Type	Required	Description
knowledge_base_query_id	string	yes

fn get_knowledge_base_search(knowledge_base_search_id: string)

get operation

Argument	Type	Required	Description
knowledge_base_search_id	string	yes

fn list_knowledge_bases(page?: number, page_size?: number)

list operation

Argument	Type	Required	Description
page?	number	no
page_size?	number	no

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	Required
asset_paths?	array	no
config	unknown	yes
description?	string	no
embedding_model?	unknown	no
name	string	yes
transforms?	array	no
type	string	yes
use_default_embedding_model?	boolean	no

fn get_knowledge_base(knowledge_base_id: string)

get operation

Argument	Type	Required	Description
knowledge_base_id	string	yes

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	Required
knowledge_base_id	string	yes
asset_paths?	array	no
config	unknown	yes
description?	string	no
embedding_model?	unknown	no
name?	string	no
schedule_expression?	string	no
transforms?	array	no
type	string	yes
use_default_embedding_model?	boolean	no

fn delete_knowledge_base(knowledge_base_id: string)

delete operation

Argument	Type	Required	Description
knowledge_base_id	string	yes

fn list_knowledge_base_jobs(knowledge_base_id: string, page?: number, page_size?: number, status?: string)

list operation

Argument	Type	Required	Description
knowledge_base_id	string	yes
page?	number	no
page_size?	number	no
status?	string	no	Comma-separated list of statuses to filter by.

fn create_knowledge_base_job(knowledge_base_id: string)

create operation

Argument	Type	Required	Description
knowledge_base_id	string	yes

fn list_knowledge_base_queries(knowledge_base_id: string, page?: number, page_size?: number)

list operation

Argument	Type	Required
knowledge_base_id	string	yes
page?	number	no
page_size?	number	no

fn query_knowledge_base(knowledge_base_id: string, query?: string, query_args?: unknown)

action operation

Argument	Type	Required
knowledge_base_id	string	yes
query?	string	no
query_args?	unknown	no

fn search_knowledge_base(knowledge_base_id: string, query: string, query_args?: unknown)

action operation

Argument	Type	Required
knowledge_base_id	string	yes
query	string	yes
query_args?	unknown	no

fn list_knowledge_base_searches(knowledge_base_id: string, page?: number, page_size?: number)

list operation

Argument	Type	Required
knowledge_base_id	string	yes
page?	number	no
page_size?	number	no

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

04Previous Versions6

2026.10.14.1Apache-2.0(was none)Oct 14, 2026

2026.10.14.1

Added: The manifest now declares license: Apache-2.0 (SPDX). The registry quality rubric scores a declared license separately from the bundled LICENSE.md.

Upgrade note: Metadata only. No code, schema, or behavioral changes.

2026.10.07.1

Fixed: An empty successful response (for example 202 Accepted) no longer fails with a JSON parse error. Mutating methods return no data handle for it, and list methods treat an empty page as the end of the results.

Fixed: A malformed JSON body now fails with an error that names the HTTP status, method, and path, instead of a bare SyntaxError.

Fixed: Requests no longer hang indefinitely. Each attempt has a 30-second deadline and fails with timed out after <n>ms: <METHOD> <path>. Set GT_CLOUD_TIMEOUT_MS to a positive integer up to 2147483647 to change it. Retry-After waits on HTTP 429 are capped at 30 seconds.

Fixed: Pagination ends on its own page counter and stops at the first empty page. A server that ignores the page parameter can no longer return page 1 up to 20 times, and a list response that is not a JSON object fails with a clear error instead of returning an empty result. A null total_pages no longer ends pagination after the first page, and a next_page value keeps a short page going.

Fixed: Descriptions in generated argument and resource schemas are shortened at a word boundary instead of mid-word.

Fixed: create, update, and delete methods now send their declared query parameters, as get, list, and action methods already did. No current endpoint declares one, so behavior is unchanged today.

Changed: Stored resource schemas are now tolerant of unexpected data. Enums are plain strings or numbers, pattern, length, and range constraints are dropped, every response field accepts null or absence, unknown keys are kept at every level, and spec defaults are no longer filled in. A response with a new enum member or a missing field is stored instead of failing the whole call. Argument validation for requests is unchanged.

Changed: A resource declared without a response body is now stored as a loose object, so whatever the API returns is kept instead of being stripped to {}.

Changed: Generated tests now exercise every method, assert the exact request (HTTP method, path, query string, auth header, JSON body) and the written resource, and cover the shared helper's error, timeout, retry, and empty-body paths.

Upgrade note: No migration is required. Schemas only loosen, so previously stored data stays valid, and the upgrade chain gains an identity entry. The upstream Griptape API spec also changed (tag profiles, tags, license info, and engine transports were added); none of those fall under this extension, so no method here changed because of it.

2026.09.18.1

Upgrade note: Normalized npm:zod dependency version to 4.6.5 across the repo. No behavioral changes in this extension.

2026.10.07.1Oct 7, 2026

2026.10.07.1

Fixed: A malformed JSON body now fails with an error that names the HTTP status, method, and path, instead of a bare SyntaxError.

Fixed: Descriptions in generated argument and resource schemas are shortened at a word boundary instead of mid-word.

Changed: A resource declared without a response body is now stored as a loose object, so whatever the API returns is kept instead of being stripped to {}.

2026.09.18.1

Upgrade note: Normalized npm:zod dependency version to 4.6.5 across the repo. No behavioral changes in this extension.

2026.09.18.1Sep 20, 2026

2026.09.18.1

Upgrade note: Normalized npm:zod dependency version to 4.6.5 across the repo. No behavioral changes in this extension.

2026.09.17.1Sep 17, 2026

2026.09.17.1

Regenerated from latest Griptape Cloud OpenAPI spec.

2026.09.15.1

Changed: Bump zod 4.4.3 → 4.6.5

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.

2026.09.15.1Sep 15, 2026

2026.09.15.1

Changed: Bump zod 4.4.3 → 4.6.5

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.

2026.08.29.1Aug 29, 2026

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.

05Stats

100 / 100

Downloads

Archive size

17.4 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
License2/2earned
Verified public repository2/2earned

Repository

https://github.com/webframp/swamp-extensions

06Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

07Labels

#griptape #knowledge-bases #rag #retrieval