Skip to content

Commit 515750e

Browse files
committed
docs(apps): add payload size limit info
1 parent 8f4c9f8 commit 515750e

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

apps/develop.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ app.action("my-action-name", myActionMethod);
5656
Action methods receive two parameters:
5757

5858
- `runtimeContext`: Contextual information provided by Kernel during execution
59-
- `payload`: Optional runtime data that you provide when invoking the action. [Read more](/apps/invoke#payload-parameter)
59+
- `payload`: Optional runtime data that you provide when invoking the action (max 64 KB). [Read more](/apps/invoke#payload-parameter)
6060

6161
<CodeGroup>
6262
```typescript Typescript/Javascript

apps/invoke.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import AsyncInvocation from '/snippets/openapi/post-invocations-async.mdx';
77

88
## Via API
99

10-
You can invoke your app by making a `POST` request to Kernel's API. **For automations and agents that take longer than 100 seconds, use [async invocations](/apps/invoke#asynchronous-invocations).**
10+
You can invoke your app by making a `POST` request to Kernel's API or via the CLI. Both support passing a payload. **For automations and agents that take longer than 100 seconds, use [async invocations](/apps/invoke#asynchronous-invocations).**
1111

1212
<Info>Synchronous invocations time out after 100 seconds.</Info>
1313

@@ -31,6 +31,10 @@ kernel invoke <app_name> <action_name>
3131

3232
`--payload` allows you to invoke the action with specified parameters. This enables your action to receive and handle dynamic inputs at runtime. For example:
3333

34+
<Info>
35+
Payloads are stringified JSON and have a maximum size of 64 KB. For larger inputs, store data externally (e.g., object storage or database) and pass a reference (URL or ID) in the payload instead.
36+
</Info>
37+
3438
```bash
3539
kernel invoke <app_name> <action_name>
3640
--payload '{"tshirt_size": "small", "color": "black", "shipping_address": "2 Mint Plz, San Francisco CA 94103"}'

0 commit comments

Comments
 (0)