Agent SDK reference - TypeScript changedagent-sdk/typescript
Nearest release: v2.1.240, published 7 hours after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
Recorded here
Lines+10added
Lines−1removed
From line
2,948
where the diff opens
First seen
14 Aug 2026
this site's first read of the page
Recorded edits113to this page, all time
The whole hunk
from line 2948, old and new numbered
/
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
from line 2948
29482948};
29492949```
29502950
2951Publishes a local `.html` or `.md` file as a hosted artifact page, or lists the user's published artifacts. Omit `action` or pass `"publish"` to publish `file_path`, which is required for the publish action along with `favicon`, one or two emoji for the browser tab. `title` names the published page in the browser tab and gallery when the HTML file has no `<title>` tag. `url` targets an existing artifact to update in place instead of minting a new one, and `force` is a last-resort overwrite that discards another session's published version; on a 409 conflict the normal fix is to re-read, merge, and publish again rather than pass `force`.
2951Publishes a local `.html` or `.md` file as a hosted artifact page, or lists the user's published artifacts. Omit `action` or pass `"publish"` to publish `file_path`, which is required for the publish action along with `favicon`, one or two emoji for the browser tab. `title` names the published page in the browser tab and gallery when the HTML file has no `<title>` tag. `url` targets an existing artifact to update in place instead of minting a new one.
29522952
2953`force` is a last-resort overwrite that discards a newer version another session published. On a conflict, the failed publish returns the newer content; Claude merges its changes onto that content, or re-reads the artifact, and publishes again. Pass `force` only when the user explicitly asks to discard that version.
2954
29532955Pass `"list"` to enumerate the user's published artifacts; only `limit` and `scope` may accompany it. `scope` defaults to `"mine"`, which lists artifacts the user owns; `"shared"` lists artifacts other people shared with the user, and `"all"` lists both.
29542956
29552957* `capabilities`: the runtime capabilities the published page uses, keyed by capability name, such as the [connectors the page may call](/docs/en/artifacts#pull-live-data-with-mcp-connectors). The artifact service validates the declaration and rejects a publish that names a capability the account can't use or gives one an invalid config. Pass `{}` to clear a stored declaration, and omit the field on a redeploy to keep it. Requires Agent SDK v0.3.235 or later.
from line 3482
34803482 artifactRead?: {
34813483 slug: string;
34823484 ver?: string;
3485 seeded?: false;
34833486 };
34843487};
34853488```
from line 3489
34863489
34873490Returns the fetched content with HTTP status and metadata.
34883491
3492`artifactRead` is present only when Claude fetched an artifact the session can publish to, and it always carries that artifact's `slug`.
3493
3494`seeded` is `false` on a read that didn't deliver the page's full source, and that entry carries no `ver`. The field requires Agent SDK v0.3.239 or later.
3495
34893496### WebSearch
34903497
34913498**Tool name:** `WebSearch`
from line 4223
42164223```
42174224
42184225| Field | Type | Description |
4219| :------------ | :-------------------- | :------------------------------------------------------------------- |
4220| `name` | `string` | Agent type identifier (e.g., `"Explore"`, `"general-purpose"`) |
4221| `description` | `string` | Description of when to use this agent |
4222| `model` | `string \| undefined` | Model alias this agent uses. If omitted, inherits the parent's model |
4223
4224### `McpServerStatus`
4225
4226
4226| :------------ | :-------------
No line in this hunk matches that.