Skip to content

Extensions

Beta

Set up your agent

Give your coding agent a Steel browser and the Steel skills, so that it browses and writes Steel code the right way. Learn more

Install the Steel CLI. It signs you in and installs the skills for your coding agents.

curl -fsS https://setup.steel.dev | sh

Or send this prompt to your coding agent, and it does the same:

Read https://setup.steel.dev/install.md and follow it to set up Steel for this coding client.
Then continue my requested task using the installed Steel skill.

Set up your agent →

Load a Chrome extension, such as a crypto wallet or a tool that your team built, into your sessions. Upload it once, and Steel stores it for your organization. Then load it into any session by its ID.

Before you begin

Put your Steel API key in the STEEL_API_KEY environment variable. Then install the Steel SDK.

npm install steel-sdk

Upload an extension

Call client.extensions.upload with one of these sources:

  • url: the extension's Chrome Web Store URL. Copy it from the extension's page.
  • file: a packaged extension file of at most 500 MB. The package needs a manifest.json file with the extension's name and version.

This program uploads an extension from the Chrome Web Store and prints its ID.

upload-extension.mts
import Steel from "steel-sdk";

const client = new Steel();

const extension = await client.extensions.upload({
  url: "https://chromewebstore.google.com/detail/github-isometric-contribu/mjoedlfflcchnleknnceiplgaeoegien",
});
console.log(extension.id, extension.name);

Run the program:

npx tsx upload-extension.mts

The program prints the extension's ID and name. Keep the ID, because you load the extension by it. The ID is the Chrome extension ID, and Steel makes the name from the part of the URL before the ID.

mjoedlfflcchnleknnceiplgaeoegien Github_Isometric_Contribu

To upload a file, pass it in file with its name. Steel checks that the name ends in .zip or .crx. In TypeScript, createReadStream sends the name of the file that it reads. In Python, pass a tuple of the name and bytes. In Go, a file that os.Open returns sends its name. In Rust, steel_rs::Upload::open keeps the name of the file that it reads. Steel takes the extension's name from its manifest.json.

import { createReadStream } from "node:fs";

const extension = await client.extensions.upload({
  file: createReadStream("extension.zip"),
});

You can upload each extension only once. To change it, update it.

Load extensions in a session

Pass the extensions' IDs in extensionIds when you create the session. Steel installs them when the session starts.

const session = await client.sessions.create({
  extensionIds: [extension.id],
});

To load all of your organization's extensions, pass ["all_ext"].

const session = await client.sessions.create({ extensionIds: ["all_ext"] });

A profile saves the extensionIds of the session that created it.

Update or delete an extension

To replace an extension with a new version, call client.extensions.update with its ID and a new url or file. The ID stays the same, so your extensionIds stay the same.

await client.extensions.update(extension.id, {
  file: createReadStream("extension-v2.zip"),
});

To see your extensions, call client.extensions.list. It returns extensions, each with its id, name, createdAt and updatedAt, and count, the number of extensions.

To remove one extension, call client.extensions.delete with its ID. To remove all of your organization's extensions, call deleteAll in TypeScript, delete_all in Python and Rust, or DeleteAll in Go.

await client.extensions.delete(extension.id);

Check that it worked

Call client.extensions.list. It returns the extension with the id and name that the upload printed. Then start a session with that ID in extensionIds, open a page that the extension acts on, and watch the page in the live view. The page shows what the extension adds or changes.

Troubleshooting

Extension already exists in your organization

{
  "error": "Bad Request",
  "message": "Extension already exists in your organization. Use the update endpoint for that extension id, or upload a different extension.",
  "retryable": false,
  "linkToDocs": "https://docs.steel.dev/overview/extensions-api/overview"
}

Cause: You uploaded an extension that your organization already has.

Fix: Find its ID with client.extensions.list, and call client.extensions.update with that ID to change it.

Verify: The update returns the extension with a new updatedAt.

Extension file must be a .zip archive or .crx file

{
  "error": "Bad Request",
  "message": "Extension file must be a .zip archive or .crx file. Upload a packaged Chrome extension in one of those formats.",
  "retryable": false,
  "linkToDocs": "https://docs.steel.dev/overview/extensions-api/overview"
}

Cause: The uploaded file has no name, or its name does not end in .zip or .crx. A file that you pass as raw bytes, without a name, fails this way.

Fix: Pass the file with its name, as the examples in Upload an extension do.

Verify: The upload returns the extension's id.

Extension was not found in your organization

{
  "error": "Not Found",
  "message": "Extension 'mjoedlfflcchnleknnceiplgaeoegien' was not found in your organization. Check the extension id, or list your extensions to confirm it exists.",
  "retryable": false,
  "linkToDocs": "https://docs.steel.dev/overview/extensions-api/overview"
}

Cause: An ID in extensionIds, or in an update or a delete, does not match any of your organization's extensions. Steel creates no session in that case.

Fix: Copy the ID from client.extensions.list, or pass ["all_ext"].

Verify: The session starts, and the response has a session id.

Next steps

  • Extensions API: Download a stored extension as a ZIP file, or call the endpoints over HTTP.