Skip to content

docs(stop): Update stopping instructions and API note #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
masnwilliams merged 3 commits into from
Sep 8, 2025
Merged

docs(stop): Update stopping instructions and API note #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6b34a50
docs(stop): Update stopping instructions and API note
masnwilliams Sep 5, 2025
db9024b
docs: update code samples from OpenAPI
github-actions[bot] Sep 5, 2025
e5b01b1
Merge branch 'main' into mason/remove-stop-invoke-via-api
masnwilliams Sep 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions apps/stop.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,14 @@
title: "Stopping"
---

import StopInvocation from '/snippets/openapi/patch-invocations-id.mdx';

You can terminate an invocation that's running. You can use this to stop automations or agents stuck in an infinite loop.
You can terminate an invocation that's running. This is useful for stopping automations or agents stuck in an infinite loop.

<Info>
Terminating an invocation also destroys any browsers associated with it.
</Info>

## Via API
You can also do this via the API:

<StopInvocation />
Stopping an invocation via the API is not available yet, but it's coming very soon.

## Via CLI
Use `ctrl-c` in the terminal tab where you launched the invocation.
12 changes: 7 additions & 5 deletions snippets/openapi/get-deployments.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ const client = new Kernel({
apiKey: 'My API Key',
});

const deployments = await client.deployments.list();

console.log(deployments);
// Automatically fetches more pages as needed.
for await (const deploymentListResponse of client.deployments.list()) {
console.log(deploymentListResponse.id);
}
```


Expand All @@ -18,7 +19,8 @@ from kernel import Kernel
client = Kernel(
api_key="My API Key",
)
deployments = client.deployments.list()
print(deployments)
page = client.deployments.list()
page = page.items[0]
print(page.id)
```
</CodeGroup>