Skip to main content

Griptape/structures

@webframp/griptape/structuresv2026.10.21.1· Apache-2.0· 5d agoBEHAVIORS
01README

Griptape Cloud Structures — deployed structures, runs, logs, and spans

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 webhook api_key argument of get_invoke_structure_webhook_get and invoke_structure_webhook_post was not marked sensitive, so swamp did not redact it. It is now. The code_source argument of create_structure_deployment, which can carry a GitHub access token, is marked sensitive too.

Added: The README lists these arguments and tells you to pass them as vault.get expressions. 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/structuresv2026.10.21.1griptape/structures.ts

Global Arguments

ArgumentTypeDescription
apiKey?stringGriptape 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?stringGriptape Cloud API base URL; overrides the GT_CLOUD_BASE_URL environment variable and the built-in default.
fn get_structure_run(structure_run_id: string)
get operation
ArgumentTypeDescription
structure_run_idstring
fn cancel_structure_run(structure_run_id: string)
action operation
ArgumentTypeDescription
structure_run_idstring
fn list_events(structure_run_id: string, limit?: string, offset?: string)
list operation
ArgumentTypeDescription
structure_run_idstring
limit?string
offset?string
fn create_events(structure_run_id: string, events?: array)
create operation
ArgumentTypeDescription
structure_run_idstring
events?array
fn list_structure_run_logs(structure_run_id: string)
list operation
ArgumentTypeDescription
structure_run_idstring
fn list_spans(structure_run_id: string, page?: number, page_size?: number)
list operation
ArgumentTypeDescription
structure_run_idstring
page?number
page_size?number
fn list_structures(page?: number, page_size?: number)
list operation
ArgumentTypeDescription
page?number
page_size?number
fn create_structure(code?: unknown, description?: string, env_vars?: array, name: string, structure_config_file?: string, webhook_enabled?: boolean)
create operation
ArgumentTypeDescription
code?unknown
description?string
env_vars?array
namestring
structure_config_file?string
webhook_enabled?boolean
fn get_structure(structure_id: string)
get operation
ArgumentTypeDescription
structure_idstring
fn update_structure(structure_id: string, code?: unknown, description?: string, env_vars?: array, name?: string, structure_config_file?: string, webhook_enabled?: boolean)
update operation
ArgumentTypeDescription
structure_idstring
code?unknown
description?string
env_vars?array
name?string
structure_config_file?string
webhook_enabled?boolean
fn delete_structure(structure_id: string)
delete operation
ArgumentTypeDescription
structure_idstring
fn list_structure_deployments(structure_id: string, page?: number, page_size?: number, status?: string)
list operation
ArgumentTypeDescription
structure_idstring
page?number
page_size?number
status?stringComma-separated list of deployment statuses to filter by.
fn create_structure_deployment(structure_id: string, code_source?: unknown, force?: boolean)
create operation
ArgumentTypeDescription
structure_idstring
code_source?unknown
force?boolean
fn list_structure_runs(structure_id: string, page?: number, page_size?: number, status?: string)
list operation
ArgumentTypeDescription
structure_idstring
page?number
page_size?number
status?stringComma-separated list of run statuses to filter by.
fn create_structure_run(structure_id: string, args: array, env_vars?: array)
create operation
ArgumentTypeDescription
structure_idstring
argsarray
env_vars?array
fn get_invoke_structure_webhook_get(structure_id: string, api_key?: string)
Invoke a webhook for a structure. Must have the `webhook_enabled` flag set to `true`.
ArgumentTypeDescription
structure_idstring
api_key?string
fn invoke_structure_webhook_post(structure_id: string, api_key?: string)
Invoke a webhook for a structure, sending the POST body as the first Structure arg. Must have the `webhook_enabled` flag set to `true`.
ArgumentTypeDescription
structure_idstring
api_key?string

Resources

structure_run(infinite)— get operation
events(infinite)— list operation
events_result(infinite)— create operation
structure_run_logs(infinite)— list operation
spans(infinite)— list operation
structures(infinite)— list operation
structure(infinite)— create operation
structure_deployments(infinite)— list operation
structure_deployment(infinite)— create operation
structure_runs(infinite)— list operation
invoke_structure_webhook_get(infinite)— Invoke a webhook for a structure. Must have the `webhook_enabled` flag set to `true`.
invoke_structure_webhook_post(infinite)— Invoke a webhook for a structure, sending the POST body as the first Structure arg. Must have the `webhook_enabled` flag set to `true`.
04Previous Versions6
2026.10.14.1Apache-2.0(was none)

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.

Fixed: create_events wrote its response into the events resource, which holds the list_events snapshot and rejects anything that is not a list envelope. It now writes to a separate events_result resource. Data already stored under events is untouched, and list_events is unchanged. Anything that read create_events output from events must read events_result instead.

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.1

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.

Fixed: create_events wrote its response into the events resource, which holds the list_events snapshot and rejects anything that is not a list envelope. It now writes to a separate events_result resource. Data already stored under events is untouched, and list_events is unchanged. Anything that read create_events output from events must read events_result instead.

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.

Modified 1 behaviors

2026.09.18.1

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.1

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/structures with 17 methods covering the Griptape Cloud structures API surface.

2026.09.15.1

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/structures with 17 methods covering the Griptape Cloud structures API surface.

2026.08.29.1

2026.08.29.1

Added: Initial code-generated release of @webframp/griptape/structures with 17 methods covering the Griptape Cloud structures API surface.

05Stats
A
100 / 100
Downloads
33
Archive size
18.5 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
06Platforms
07Labels