Griptape/structures
@webframp/griptape/structuresv2026.08.29.1
01README
Griptape Cloud Structures — deployed structures, runs, logs, and spans
02Release Notes
2026.08.29.1
Added: Initial code-generated release of @webframp/griptape/structures with 17 methods covering the Griptape Cloud structures API surface.
03Models
@webframp/griptape/structuresv2026.08.29.1griptape/structures.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_structure_run(structure_run_id: string)
get operation
| Argument | Type | Description |
|---|---|---|
| structure_run_id | string |
fn cancel_structure_run(structure_run_id: string)
action operation
| Argument | Type | Description |
|---|---|---|
| structure_run_id | string |
fn list_events(structure_run_id: string, limit?: string, offset?: string)
list operation
| Argument | Type | Description |
|---|---|---|
| structure_run_id | string | |
| limit? | string | |
| offset? | string |
fn create_events(structure_run_id: string, events?: array)
create operation
| Argument | Type | Description |
|---|---|---|
| structure_run_id | string | |
| events? | array |
fn list_structure_run_logs(structure_run_id: string)
list operation
| Argument | Type | Description |
|---|---|---|
| structure_run_id | string |
fn list_spans(structure_run_id: string, page?: number, page_size?: number)
list operation
| Argument | Type | Description |
|---|---|---|
| structure_run_id | string | |
| page? | number | |
| page_size? | number |
fn list_structures(page?: number, page_size?: number)
list operation
| Argument | Type | Description |
|---|---|---|
| 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
| Argument | Type | Description |
|---|---|---|
| code? | unknown | |
| description? | string | |
| env_vars? | array | |
| name | string | |
| structure_config_file? | string | |
| webhook_enabled? | boolean |
fn get_structure(structure_id: string)
get operation
| Argument | Type | Description |
|---|---|---|
| structure_id | string |
fn update_structure(structure_id: string, code?: unknown, description?: string, env_vars?: array, name?: string, structure_config_file?: string, webhook_enabled?: boolean)
update operation
| Argument | Type | Description |
|---|---|---|
| structure_id | string | |
| code? | unknown | |
| description? | string | |
| env_vars? | array | |
| name? | string | |
| structure_config_file? | string | |
| webhook_enabled? | boolean |
fn delete_structure(structure_id: string)
delete operation
| Argument | Type | Description |
|---|---|---|
| structure_id | string |
fn list_structure_deployments(structure_id: string, page?: number, page_size?: number, status?: string)
list operation
| Argument | Type | Description |
|---|---|---|
| structure_id | string | |
| page? | number | |
| page_size? | number | |
| status? | string | Comma-separated list of deployment statuses to filter by. |
fn create_structure_deployment(structure_id: string, code_source?: unknown, force?: boolean)
create operation
| Argument | Type | Description |
|---|---|---|
| structure_id | string | |
| code_source? | unknown | |
| force? | boolean |
fn list_structure_runs(structure_id: string, page?: number, page_size?: number, status?: string)
list operation
| Argument | Type | Description |
|---|---|---|
| structure_id | string | |
| page? | number | |
| page_size? | number | |
| status? | string | Comma-separated list of run statuses to filter by. |
fn create_structure_run(structure_id: string, args: array, env_vars?: array)
create operation
| Argument | Type | Description |
|---|---|---|
| structure_id | string | |
| args | array | |
| 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`.
| Argument | Type | Description |
|---|---|---|
| structure_id | string | |
| 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`.
| Argument | Type | Description |
|---|---|---|
| structure_id | string | |
| api_key? | string |
Resources
structure_run(infinite)— get operation
events(infinite)— list 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`.
04Stats
A
100 / 100
Downloads
0
Archive size
19.0 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